SharedLinkRecipient

View as Markdown

Struct for visitor shared link recipient.

Full name	`MFiles.SharedLinkRecipient`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`email`	`string`	1	The recipient email.
`access_time`	`google.protobuf.Timestamp`	2	The access time for the shared link. Is set by the server.
`created_by_user`	`int32`	3	The creator of this shared Link.
`shared_link_notification`	`SharedLinkNotification`	4	Shared link notification type.Values: `SHARED_LINK_NOTIFICATION_NONE` (0), `SHARED_LINK_NOTIFICATION_ALWAYS` (1).
`expires_at_utc`	`google.protobuf.Timestamp`	5	The expiration time for the shared link. Use FILETIME_ZERO to indicate no expiration time.
`external_shared_link_access_type`	`ExternalSharedLinkAccessType`	6	The access type of the recipient.Values: `EXTERNAL_SHARED_LINK_ACCESS_TYPE_UNINITIALIZED` (0), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_DOWNLOAD` (1), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_PREVIEW` (2), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_EDIT` (3).
`created_by_user_name`	`string`	7	The user who created the shared link.

Used by methods

IRPCSharedLinks.AddSharedLinkRecipients -- Adds visitors (email recipients) to an external or visitor link and returns all its recipients.
IRPCSharedLinks.GetSharedLinkRecipients -- Lists the visitors (email recipients) of an external or visitor link.

Used in fields

SetSharedLinkRecipient.recipient -- The information about the shared link recipient linked to the access key to update expiration time and access type.
AddSharedLinkRecipientsResponse.recipients -- All recipients of the link that the caller can see.
GetSharedLinkRecipientsResponse.recipients -- The recipients, with their expiration time and access type.