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

    Interface CreateChannelInput

    Properties required or optional when creating a new channel.

    CreateChannelInput

    interface CreateChannelInput {
        avatar?: AvatarInput;
        defaultMemberRole: ChannelRole;
        description?: string;
        handleId: HandleId;
        invitedHandleIds: HandleId[];
        joinRule: ChannelJoinRule;
        name?: string;
        permissions: ChannelPermissionsInput;
        tags: string[];
    }
    Index

    Properties

    avatar?: AvatarInput

    Optional file to use as the channel's avatar.

    defaultMemberRole: ChannelRole

    The default role members inherit when joining the channel.

    description?: string

    Optional explanation about what the channel is about.

    handleId: HandleId

    Identifier of the handle owned by this client.

    invitedHandleIds: HandleId[]

    The identifiers of the handles to invite immediately when the channel is created.

    joinRule: ChannelJoinRule

    The rule for joining and whether the channel is searchable.

    name?: string

    Optional display name for the channel.

    Change which actions a member of a certain role can take.

    tags: string[]

    A list of words to help searchability.