TdxCloudStorageItemPermissions.InviteUsers(TArray<string>,Boolean,Boolean,Boolean,string) Method
Declaration
procedure InviteUsers(const AUsers: TArray<string>; AReadOnly: Boolean = True; ARequireSignIn: Boolean = False; ASendInvitation: Boolean = False; const AMessage: string = '');Parameters
| Name | Type | Description |
|---|---|---|
| AUsers | TArray<T> | An array of emails for which the function generates access permissions. |
| AReadOnly | Boolean | If True, the function generates read-only access permissions for the specified users; otherwise, the users can edit the cloud resource. |
| ARequireSignIn | Boolean | If True, the specified users need to sign in to a Microsoft OneDrive® or SharePoint® storage account to access the cloud resource; otherwise, the generated access permissions allow anonymous access. This parameter value affects only Microsoft services. |
| ASendInvitation | Boolean | If True, the cloud storage sends invitation emails to all specified users; otherwise, users receive no notifications. |
| AMessage | string | A custom message sent in invitation emails. This parameter has no effect if the ASendInvitation parameter value is False. |
Remarks
Call this procedure and pass an array of emails as the AUsers parameter to create a series of read-only access permissions for the specified users.
You can pass False as the optional AReadOnly parameter to create a series of permissions to edit the cloud resource instead.
The optional ARequireSignIn parameter specifies if the specified users need to sign into a Microsoft OneDrive® or SharePoint® storage account to access the shared resource. This parameter value is ignored for all other supported cloud storage services.
The optional ASendInvitation parameter specifies whether the cloud storage service should send invitation emails to all specified users. You can also use the optional AMessage parameter to add a custom message to sent invitations.
Note
A cloud storage component’s OnItemPermissionCreated event occurs every time the InviteUsers procedure creates a permission. This event can occur multiple times per single InviteUsers procedure call, and once per user specified in the AUsers array.