@sudoplatform/sudo-secure-communications
    Preparing search index...

    Class ChannelPermissions

    Permissions of certain channel chat functions and capabilities. Each chat capability requires a minimum ChannelRole for handles to be able to execute.

    Index

    Constructors

    constructor

    Properties

    banHandles changeChannelAvatar changeChannelDescription changeChannelName deleteOthersMessages inviteHandles kickHandles sendMessages default

    Constructors

    • Interface

      Constructs a new instance of channel permissions with role-based access control.

      ChannelPermissions

      Parameters

      • sendMessages: ChannelRole

        What role can send messages in the chat.

      • inviteHandles: ChannelRole

        What role can invite other handles.

      • kickHandles: ChannelRole

        What role can kick other handles.

      • banHandles: ChannelRole

        What role can ban other handles.

      • changeChannelName: ChannelRole

        What role can change the channel's name.

      • changeChannelDescription: ChannelRole

        What role can change the channel's description.

      • changeChannelAvatar: ChannelRole

        What role can change the channel's avatar.

      • deleteOthersMessages: ChannelRole

        What role can delete anyone's messages.

      Returns ChannelPermissions

    Properties

    banHandles: ChannelRole
    changeChannelAvatar: ChannelRole
    changeChannelDescription: ChannelRole
    changeChannelName: ChannelRole
    deleteOthersMessages: ChannelRole
    inviteHandles: ChannelRole
    kickHandles: ChannelRole
    sendMessages: ChannelRole
    default: ChannelPermissions = ...

    Default required roles necessary to perform each action for new channels if not overridden with ChannelPermissionsInput.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties