UnshareAttachment function

Syntax

UnshareAttachment(URLID, DirAndFilePrefix, ShareMode, ShareRole, UsernameArray)

Description

Use the UnshareAttachment function to revoke sharing access to files in Oracle Content and Experience Cloud (CEC).

Parameters

Parameter Description

URLID

Specifies an Oracle Content Cloud.

DirAndFilePrefix

A directory and file name prefix. This is appended to the folder path configured in the URLID parameter to get the actual file.

Note: Because the DirAndFilePrefix parameter is appended to the URL, it requires forward slashes (“/”). Backward slashes (“\”) are not supported for this parameter.

ShareMode

Specifies the sharing mode, which is revoked.

The sharing modes are:

  • %ShareMode_Member

  • %ShareMode_PublicRegisteredUsers

  • %ShareMode_PublicAnyone

ShareRole

Specifies the sharing roles, which is revoked.

The sharing roles are:

  • %ShareRole_Viewer

  • %ShareRole_Downloader

  • %ShareRole_Contributor

This parameter is not used when the sharing mode is %ShareMode_Member.

UsernameArray

Specifies users who are to be removed from sharing list.

This parameter is not used when the sharing mode is %ShareMode_PublicRegisteredUsers or %ShareMode_PublicAnyone.

If no value is passed in this parameter, an empty string array is assumed.

This is an optional parameter.

Returns

An integer value (0) irrespective of whether the function is successful or not.

Note:

It is reserved for future use.

Example

Local array of string &users = CreateArrayRept("XYZ", 1);
Local string &share_url = "https://<host:port>/documents/fileview/<docID>/_PaySlip_XYZ";
UnshareAttachment(URLID.PAYSLIP, "PaySlip_XYZ", &share_url, %ShareMode_Member, 0, &users);

Related Topics