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

    Interface UpdateChannelInput

    Updatable fields when making an update to a channel. If a field's Input is undefined, that setting is not modified. If the value inside the Input is undefined, that setting is unset.

    UpdateChannelInput

    interface UpdateChannelInput {
        avatar?: Input<AvatarInput | undefined>;
        channelId: ChannelId;
        defaultMemberRole?: Input<ChannelRole>;
        description?: Input<string | undefined>;
        handleId: HandleId;
        joinRule?: Input<ChannelJoinRule>;
        name?: Input<string | undefined>;
        permissions?: Input<ChannelPermissionsInput | undefined>;
        tags?: Input<string[]>;
    }
    Index

    Properties

    avatar? channelId defaultMemberRole? description? handleId joinRule? name? permissions? tags?

    Properties

    avatar?: Input<AvatarInput | undefined>

    File to upload to use as the channel's avatar.

    channelId: ChannelId

    The identifier of the channel to update.

    defaultMemberRole?: Input<ChannelRole>

    The default role members inherit when joining the channel. Updating this field will change the role for all members who have not had their role explicitly set.

    description?: Input<string | undefined>

    An explanation about what the channel is about.

    handleId: HandleId

    Identifier of the handle owned by this client.

    joinRule?: Input<ChannelJoinRule>

    The rule for joining and whether the channel is searchable.

    name?: Input<string | undefined>

    The display name for the channel.

    permissions?: Input<ChannelPermissionsInput | undefined>

    Change which actions a member of a certain role can take. If the value is undefined, the channel permissions are reset back to the defaults.

    tags?: Input<string[]>

    A list of words to help searchability.

    Settings

    Member Visibility

    On This Page

    Properties