AddPermission

Represents a request to grant one or more users access to a file/folder.

Constructors

global AddPermission()

---

Fields

global expirationDateTime → Datetime

AURAENABLED INVOCABLEVARIABLE

Date and time after which the permission expires.

global itemId → String

AURAENABLED OTHER

Id of the drive item (file or folder) for which the recipients will be granted permissions.

global message → String

AURAENABLED INVOCABLEVARIABLE

A plain text formatted message that is included in the sharing invitation, max 2000 chars.

global objectSettingsName → String

AURAENABLED INVOCABLEVARIABLE

The API name of the SharePoint Object Setting Custom Metadata used to complete the action.

global reason → String

AURAENABLED INVOCABLEVARIABLE

The reason why the permission was added to the given recipients, max 2000 chars.

global recipient → String

AURAENABLED INVOCABLEVARIABLE

The 36-character SharePoint User Id of the person who will receive access and the sharing invitation. Used only in flows.

global recipients → List<String>

AURAENABLED

A list of 36-character SharePoint User Ids of the people who will receive access and the sharing invitation. Used only in Apex.

global requireSignIn → Boolean

AURAENABLED INVOCABLEVARIABLE

Whether the recipient of the invitation is required to sign-in to view the shared item.

global retainInheritedPermissions → Boolean

AURAENABLED INVOCABLEVARIABLE

If true, any existing inherited permissions are retained on the shared item when sharing this item for the first time. If false, all existing permissions are removed when sharing for the first time. Default is true.

global roles → String

AURAENABLED OTHER

The permission role that will be granted to the recipient of the sharing invitation (“read” or “write”).

global sendInvitation → Boolean

AURAENABLED INVOCABLEVARIABLE

If true, a sharing link is sent to the recipient. Otherwise, a permission is granted directly without sending a notification.

---