( Return to API Overview )
- disableUserRestrictions
- enableUserRestrictions
- getOrgSharing
- setOrgSharing
Description
Provides methods to retrieve and alter channel access restrictions.
Namespace:
channel.access
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.
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.
Description:
Get organization sharing access control.
Parameters:
-
string sessionKey
-
string channelLabel - label of the channel
Returns:
-
string - The access value (one of the following: 'public',
'private', or 'protected'.
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.
Generated on 1/9/2019