core/com.tecknobit.refycore.records.links/CustomRefyLink

CustomRefyLink

@Entity

The CustomRefyLink class is useful to represent a custom Refy's link, useful to share resources and allowing to protect them with an authentication form with custom fields

Author

N7ghtm4r3 - Tecknobit

Constructors

CustomRefyLink

constructor()

Constructor to init the CustomRefyLink class No-any params required

constructor(id: String, owner: RefyUser, title: String, description: String, referenceLink: String, creationDate: Long, uniqueAccess: Boolean, expiredTime: CustomRefyLink.ExpiredTime, resources: Map<String, String>, fields: Map<String, String>, previewToken: String)

Constructor to init the CustomRefyLink class

constructor(jCustomRefyLink: JSONObject)

Constructor to init the CustomRefyLink class

Types

ExpiredTime

enum ExpiredTime

ExpiredTime list of available expiration time

Properties

collections

protected val collections: List<LinksCollection>

collections the collections where the link is shared

CREATION_DATE_KEY

val CREATION_DATE_KEY: String = "creation_date"

CREATION_DATE_KEY the key for the "creation_date" field

creationDate

private val creationDate: Long

creationDate when the link has been created

CUSTOM_LINK_KEY

val CUSTOM_LINK_KEY: String = "custom_link"

CUSTOM_LINK_KEY the key for the "custom_link" field

CUSTOM_LINKS_PATH

val CUSTOM_LINKS_PATH: String = "customLinks"

CUSTOM_LINKS_PATH the key for the "customLinks" url path

description

protected val description: String

description the description of the item

DESCRIPTION_KEY

val DESCRIPTION_KEY: String = "description"

DESCRIPTION_KEY the key for the "description" field

DISCRIMINATOR_VALUE_KEY

val DISCRIMINATOR_VALUE_KEY: String = "dtype"

EXPIRED_TIME_KEY

val EXPIRED_TIME_KEY: String = "expired_time"

EXPIRED_TIME_KEY the key for the "expired_time" field

expiredTime

val expiredTime: CustomRefyLink.ExpiredTime

expiredTime if set, when the link expires and automatically deleted

FIELD_KEY

val FIELD_KEY: String = "field_key"

FIELD_KEY the key for the "field_key" field

FIELD_VALUE_KEY

val FIELD_VALUE_KEY: String = "field_value"

FIELD_VALUE_KEY the key for the "field_value" field

fields

val fields: Map<String, String>

fields the fields used to protect the resources with a validation form

FIELDS_KEY

val FIELDS_KEY: String = "fields"

FIELDS_KEY the key for the "fields" field

hItem

protected val hItem: JsonHelper

protected val id: String

IDENTIFIER_KEY

val IDENTIFIER_KEY: String = "id"

LINK_IDENTIFIER_KEY

val LINK_IDENTIFIER_KEY: String = "link_id"

LINK_IDENTIFIER_KEY the key for the "link_id" field

LINK_KEY

val LINK_KEY: String = "link"

LINK_KEY the key for the "link" field

OWNED_ONLY_KEY

val OWNED_ONLY_KEY: String = "owned_only"

OWNED_ONLY_KEY the key for the "owned_only" field

owner

protected val owner: RefyUser

owner the owner of the item

OWNER_KEY

val OWNER_KEY: String = "owner"

OWNER_KEY the key for the "owner" field

PREVIEW_TOKEN_KEY

val PREVIEW_TOKEN_KEY: String = "preview_token"

PREVIEW_TOKEN_KEY the key for the "preview_token" field

previewToken

val previewToken: String

previewToken the token used to entry in the preview mode

REFERENCE_LINK_KEY

val REFERENCE_LINK_KEY: String = "reference_link"

REFERENCE_LINK_KEY the key for the "reference_link" field

referenceLink

protected val referenceLink: String

referenceLink the link reference value

RESOURCE_KEY

val RESOURCE_KEY: String = "resource_key"

RESOURCE_KEY the key for the "resource_key" field

RESOURCE_VALUE_KEY

val RESOURCE_VALUE_KEY: String = "resource_value"

RESOURCE_VALUE_KEY the key for the "resource_value" field

resources

val resources: Map<String, String>

resources the resources to share with the link

RESOURCES_KEY

val RESOURCES_KEY: String = "resources"

RESOURCES_KEY the key for the "resources" field

teams

protected val teams: List<Team>

teams the teams where the link is shared

timeFormatter

protected val timeFormatter: TimeFormatter

title

protected val title: String

title the title of the item

TITLE_KEY

val TITLE_KEY: String = "title"

TITLE_KEY the key for the "title" field

UNIQUE_ACCESS_KEY

val UNIQUE_ACCESS_KEY: String = "unique_access"

UNIQUE_ACCESS_KEY the key for the "unique_access" field

uniqueAccess

private val uniqueAccess: Boolean

uniqueAccess whether the link, when requested for the first time, must be deleted and no more accessible

Functions

canBeUpdatedByUser

open fun canBeUpdatedByUser(loggedUserId: String): Boolean

Method to check if the user can update the current item

expires

open fun expires(): Boolean

Method to get whether the link expires or not No-any params required

getCollections

open fun getCollections(): List<LinksCollection>

Method to get collections instance No-any params required

getCollectionsIds

open fun getCollectionsIds(): List<String>

Method to get the ids of the collections No-any params required

getCreationDate

open fun getCreationDate(): String

Method to get creationDate instance No-any params required

getCreationTimestamp

open fun getCreationTimestamp(): Long

Method to get creationDate instance No-any params required

getDescription

open fun getDescription(): String

Method to get description instance No-any params required

getExpirationDate

open fun getExpirationDate(): String

Method to get the expiration date No-any params required

getExpirationTimestamp

open fun getExpirationTimestamp(): Long

Method to get the expiration timestamp value No-any params required

getId

open fun getId(): String

getOwner

open fun getOwner(): RefyUser

Method to get owner instance No-any params required

getPreviewModeUrl

open fun getPreviewModeUrl(hostAddress: String): String

Method to get the url to enter the preview mode No-any params required

getReferenceLink

open fun getReferenceLink(): String

Method to get referenceLink instance No-any params required

getTeamIds

open fun getTeamIds(): List<String>

Method to get the ids of the teams No-any params required

getTeams

open fun getTeams(): List<Team>

Method to get teams instance No-any params required

getTitle

open fun getTitle(): String

Method to get title instance No-any params required

hasUniqueAccess

open fun hasUniqueAccess(): Boolean

Method to get uniqueAccess instance No-any params required

isExpired

open fun isExpired(): Boolean

Method to get whether the link has been expired No-any params required

loadMap

private open fun loadMap(jMap: JSONObject): Map<String, String>

Method to load a map instance

mustValidateFields

open fun mustValidateFields(): Boolean

Method to get whether the resources are protected or not No-any params required

returnCustomLinks

open fun returnCustomLinks(jLinks: JSONArray): ArrayList<CustomRefyLink>

Method to assemble and return an ArrayList of links

returnLinks

open fun returnLinks(jLinks: JSONArray): ArrayList<RefyLink>

Method to assemble and return an ArrayList of links

toString

open fun toString(): String

CustomRefyLink

Author

See also

Constructors

Types

Properties

Functions