channel.access
Description
Provides methods to retrieve and alter channel access restrictions.
Namespace:
channel.access
Method: disableUserRestrictions
HTTP POST
Description:
Disable user restrictions for the given channel. If disabled, all users within the organization may subscribe to the channel.
Parameters:
-
string sessionKey
-
string channelLabel - label of the channel
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: enableUserRestrictions
HTTP POST
Description:
Enable user restrictions for the given channel. If enabled, only selected users within the organization may subscribe to the channel.
Parameters:
-
string sessionKey
-
string channelLabel - label of the channel
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: getOrgSharing
HTTP GET
Description:
Get organization sharing access control.
Parameters:
-
string sessionKey
-
string channelLabel - label of the channel
Returns:
-
string access - The access value (one of the following: 'public', 'private', or 'protected'
Method: setOrgSharing
HTTP POST
Description:
Set organization sharing access control.
Parameters:
-
string sessionKey
-
string channelLabel - label of the channel
-
string access - Access (one of the following: 'public', 'private', or 'protected'
Returns:
-
int - 1 on success, exception thrown otherwise.