SharedLinkInfo

Struct for shared link information.

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

Fields

Field	Type	Number	Description
`access_key`	`string`	1	The access key of the shared link.
`description`	`string`	2	The description of the shared link.
`created_at_utc`	`google.protobuf.Timestamp`	3	The creation time for the shared link. Is set by the server. Should be FILETIME_ZERO, when creating a new link.
`expires_at_utc`	`google.protobuf.Timestamp`	4	The expiration time for the shared link. Use FILETIME_ZERO to indicate no expiration time.
`obj_ver`	`ObjVer`	5	The object version referenced by the shared link.
`created_by_user`	`int32`	6	The creator of this shared Link.
`file_ver`	`FileVer`	7	The file version referenced by the shared link.
`shared_link_type`	`SharedLinkType`	8	Type of the shared link.Values: `SHARED_LINK_TYPE_READ_ONLY` (0), `SHARED_LINK_TYPE_CO_AUTHORING` (1), `SHARED_LINK_TYPE_WOPIREADONLY` (2), `SHARED_LINK_TYPE_WOPIEDIT` (3), `SHARED_LINK_TYPE_VISITOR` (4), `SHARED_LINK_TYPE_EXTERNAL` (5).
`is_anyone_access_granted`	`bool`	9	True if any user has granted public access to the document.
`anyone_access_granted_by_user`	`int32`	10	The user who has granted public access to the document.
`external_shared_link_access_type`	`ExternalSharedLinkAccessType`	11	Access type of the external shared link.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`	12	The user who created the shared link.
`anyone_access_granted_by_user_name`	`string`	13	The user who granted public access.

Used by methods

IRPCSharedLinks.CreateSharedLink -- Creates a shared link to one file of an object and returns it with its new access key.
IRPCSharedLinks.GetExternalLinks -- Lists the external links of an object.
IRPCSharedLinks.GetSharedLink -- Gets one shared link by its access key.
IRPCSharedLinks.GetSharedLinks -- Lists the shared links that the caller created, or all links for users who can see all objects.
IRPCSharedLinks.GetSharedLinksByObject -- Lists the shared links to one object.
IRPCSharedLinks.SetSharedLinks -- Updates the access type of shared links, and grants or revokes access for anyone who has the link.

Used in fields

CreateSharedLinkRequest.sl_info -- The link to create: shared_link_type, obj_ver, file_ver, and optionally description, expires_at_utc (unset for no expiration) and, for external links, external_shared_link_access_type and is_anyone_access_granted.
CreateSharedLinkResponse.sl_info_result -- The created link, including its access_key.
GetSharedLinkResponse.sl_info_result -- The link.
GetSharedLinksResponse.shared_links -- The links, including their access keys.
GetSharedLinksByObjectResponse.shared_links -- The links to the object.
SetSharedLinksRequest.shared_links -- The links to update, identified by access_key, with the new external_shared_link_access_type, is_anyone_access_granted and expires_at_utc.
SetSharedLinksResponse.shared_links -- The links after the update.
GetExternalLinksResponse.external_shared_links -- The external links, including their access keys.