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

    Interface Channel

    The Sudo Platform SDK representation of a Channel. Model for a wrapper around a messaging channel with extra fields for discoverability and customization.

    Channel

    interface Channel {
        avatarUrl?: string;
        channelId: ChannelId;
        createdAt: Date;
        defaultMemberRole?: ChannelRole;
        description?: string;
        inviter?: Handle;
        joinRule?: ChannelJoinRule;
        memberCount: number;
        name?: string;
        permissions?: ChannelPermissions;
        tags: string[];
        updatedAt: Date;
    }
    Index

    Properties

    avatarUrl? channelId createdAt defaultMemberRole? description? inviter? joinRule? memberCount name? permissions? tags updatedAt

    Properties

    avatarUrl?: string

    Optional url for associated avatar image.

    channelId: ChannelId

    Unique identifier of the channel.

    createdAt: Date

    Date for when the channel was created.

    defaultMemberRole?: ChannelRole

    The default role members inherit when joining the channel.

    description?: string

    Optional explanation about what the channel is about.

    inviter?: Handle

    Optional handle of the inviter.

    joinRule?: ChannelJoinRule

    Optional rule for joining and whether the channel is searchable, if known.

    memberCount: number

    The number of joined members of the channel.

    name?: string

    Optional display name for the channel.

    permissions?: ChannelPermissions

    Mapping of which channel-related change action can be performed by which channel role. Will be undefined if the handle hasn't joined the channel.

    tags: string[]

    A list of words to help searchability.

    updatedAt: Date

    Date for when the channel was last updated.

    Settings

    Member Visibility

    On This Page

    Properties