Skip to main content

CreateLinkRequest

The request object containing the necessary details for creating the link, such as the link type, user ID, request limits, and visibility settings.

Properties

NameDescription
DelegationIdLinks the request to a specified delegation, allowing the link to operate based on the rights and positions associated with that delegation.
StatusIndicates whether the link is active or inactive. Inactive links cannot be accessed.
PayloadThe JSON formatted data or plain text necessary for the specified link type.
EmbeddedViewIndicates whether the link should hide parts of the system interface, such as the left menu and top toolbar. Typically used for displaying documents.
RequestLimitDefines the maximum number of times the link can be accessed. if is null, link is limitless.
LinkTypeIt holds the values ​​used to specify the type of the link.
ViewHideInfoProvides information on which sections of the interface should be hidden when the link is opened.
UserIdIdentifies a specific user who can access the link. If null, the link is accessible to all users.
ExpireDateSpecifies the date and time when the link will expire. If null, the link remains accessible indefinitely.
LanguageDefines the language of the link, such as en-US, tr-TR, etc.
ScopeSpecifies the permission range that the link should adhere to.

Constructors

NameDescription
CreateLinkRequest()Initializes a new instance of the CreateLinkRequest class.