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

    Interface PublicChannelSearchResult

    The Sudo Platform SDK representation of a Public Channel Search Result.

    PublicChannelSearchResult

    interface PublicChannelSearchResult {
        avatarUrl?: string;
        channelId: ChannelId;
        createdAt: Date;
        description?: string;
        joinRule: PublicChannelJoinRule;
        memberCount: number;
        name: string;
        tags: string[];
        updatedAt: Date;
    }
    Index

    Properties

    avatarUrl? channelId createdAt description? joinRule memberCount name tags updatedAt

    Properties

    avatarUrl?: string

    Optional url for associated avatar image.

    channelId: ChannelId

    Unique identifier of the public channel.

    createdAt: Date

    Date for when the public channel was created.

    description?: string

    Optional explanation about what the channel is about.

    joinRule: PublicChannelJoinRule

    Optional rule for joining.

    memberCount: number

    The number of joined members of the public channel.

    name: string

    Display name of the public channel.

    tags: string[]

    A list of words to help searchability.

    updatedAt: Date

    Date for when the public channel was last updated.

    Settings

    Member Visibility

    On This Page

    Properties