CreatePermission Method

Create a new Permissions for the specified folder and user.

Syntax

sharefile.createPermission(folderId, userId, recursive, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Creates a new permission for a specified folder and user. The Permission* properties will not be updated with the new permission until the ListPermissions or GetPermissionInfo methods are called. FolderId is the id of the folder to add the permission to. UserId is the id of the user who will be getting the new permission. Recursive is to true when the user needs permission for all sub-folders within the specified folder. The CreatePermissionOptions* properties can be used to specify the different options for the newly created permission.

The CreatePermissionNotify and CreatePermissionNotifyMessage configurations can be used to notify the user at the email set in the Permission* properties.

string FolderId = shareFile.CreateFolder("test", "home");
string UserId = CreateUser("First", "Last", example@example.com, "company");
shareFile.Config("CreatePermissionNotify=True");
shareFile.Config("CreatePermissionNotifyMessage=CreatePermissionNotifyConfigTest");
shareFile.CreatePermission(FolderId, UserId, true);