TdxCloudStorage.CreateSharedLink(TdxCloudStorageItem,Boolean,TdxCloudStorageItemPermissionScope) Method
Creates a shared link with a permission to view or edit a file or folder on a connected storage server.
Declaration
function CreateSharedLink(AItem: TdxCloudStorageItem; AReadOnly: Boolean = True; AScope: TdxCloudStorageItemPermissionScope = TdxCloudStorageItemPermissionScope.Anonymous): TdxCloudStorageItemPermission;Parameters
| Name | Type | Description |
|---|---|---|
| AItem | TdxCloudStorageItem | A cloud storage metadata container that corresponds to the target file or folder. |
| AReadOnly | Boolean | If True, the function creates a read-only access permission; otherwise, creates a permission to edit the cloud resource. |
| AScope | TdxCloudStorageItemPermissionScope | Enumerates access permission scopes. |
Returns
| Type | Description |
|---|---|
| TdxCloudStorageItemPermission | An access permission. |
Remarks
Call this function to create a new permission to view a file or folder on a cloud storage server with anonymous access. The CreateSharedLink function returns a new access permission. You can use its Link property to obtain the associated shared link. To revoke any access permission and render the shared link invalid, call the DeletePermission procedure and pass the target permission as a parameter.
You can pass False as the optional AReadOnly parameter to create a permission to edit the cloud resource instead.
The optional Scope parameter specifies the scope of the newly created access permission. You can pass TdxCloudStoragePermissionScope.Organization as this parameter to create a shared link usable only by members of the organization to which the connected Microsoft SharePoint® or OneDrive® storage account belongs.
Note
A CreateSharedLink procedure call raises the OnItemPermissionCreated event when a shared link is successfully created.
Important
The AScope parameter value affects only Microsoft cloud storage accounts. This parameter is always ignored for any other cloud storage provider. Refer to the TdxCloudStorageItemPermissionScope type description for detailed information.