CreatePermission Method

Create a new Permissions for the specified folder and user.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int CreatePermission(const char* lpszFolderId, const char* lpszUserId, int bRecursive);

Unicode (Windows)
INT CreatePermission(LPCWSTR lpszFolderId, LPCWSTR lpszUserId, BOOL bRecursive);

- (void)createPermission:(NSString*)folderId :(NSString*)userId :(BOOL)recursive;

#define MID_SHAREFILE_CREATEPERMISSION 10

IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_ShareFile_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)