Accepts an invitation to join a channel.
Parameters used to accept an invitation to join a channel.
Accept an invitation request to join a channel.
Parameters used to accept an invitation request to join a channel.
Bans a handle from a channel. Must have a higher role than the target handle to perform this action.
Parameters used to ban a handle from a channel.
Create a new channel.
Invites handles to the newly created channel if a list of handle identifiers are supplied in the input.
Parameters with the initial fields state for the new channel.
The newly created channel.
Decline an invitation to join a channel.
Parameters used to decline an invitation to join a channel.
Decline an invitaton request to join a channel. Must have a higher role than the target handle to perform this action.
Parameters used to decline an invitation request to join a channel.
Delete an existing channel.
Note: The channel needs to be private before deleting due to technical constraints.
Note: The handle has to have a higher power level than everyone else in the channel in order to delete it for others. This usually means that only the host of a channel can delete it.
Parameters used to delete an existing channel.
Retrieve an individual channel by the channel's identifier.
Parameters used to retrieve a channel.
The channel matching the input identifier, or undefined if not found.
Retrieves a list of all members of a channel that the current handle is a member of.
Parameters used to retrieve a list of all channel members of a channel.
The list of channel members in the channel.
Get the state of membership of the current handle in the channel.
Note: When a handle is not actively in the channel (status is either MembershipState.LEFT or MembershipState.BANNED), they will not receive membership state updates. This means the handle cannot observe transitions between MembershipState.LEFT and MembershipState.BANNED states. For consistent state management, it's recommended to treat both these states as "not in channel" rather than distinguishing between them.
Parameters used to retrieve the membership of the current handle in the channel.
The membership state of the handle in the channel, or undefined if unknown. Undefined usually means the handle has never intereacted with the channel which is equivalent to MembershipState.LEFT.
Batch retrieve channels with a list of channel identifiers.
Parameters used to retrieve a list of channels.
List of channels matching the supplied identifiers, less any identifiers that did not correspond to a channel.
Add this handle to an existing channel by identifier. Only public channels can be joined without an invitation.
Parameters used to add a handle to a channel.
Kicks a handle from a channel. Must have a higher role than the target handle to perform this action. Can kick yourself.
Parameters used to kick a handle from a channel.
Remove this handle from a specified channel by identifier.
Parameters used to remove a handle from a channel.
Retrieve all channel invitation requests received by a specific channel.
Parameters used to query for a list of received invitation requests.
A list of channel invitation requests for the specified channel.
Search existing channels that have fields matching the supplied inputs. Only public channels are searchable.
Parameters used to search for public channels.
A list of all public channel search results matching the search criteria.
Send an invitation request to join a channel.
Parameters used to send an invitation request to join a channel.
Invite handles to join an existing channel.
Parameters used to invite handles to join a channel.
Unbans a handle from a channel. Must have a higher role than the target handle to perform this action.
Parameters used to unban a handle from a channel.
Update the editable fields of a channel.
Parameters defining the changed settings of a channel.
The updated channel.
Updates the channel role for a specific member of a channel. Must have a higher role than the target handle to perform this action. Can downgrade your own role.
Parameters used to update the channel role of a member in the channel.
Withdraw a previously sent channel invitation. Must have a higher role than the target handle to perform this action.
Parameters used to withdraw a channel invitation.
Withdraw a previously sent channel invitation request.
Parameters used to withdraw an invitation request to join a channel.
Channel management for the Secure Communications Service.