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

    Interface PublicChannelSearchInput

    Properties required to search for existing public channels that have fields matching inputs.

    PublicChannelSearchInput

    interface PublicChannelSearchInput {
        handleId: HandleId;
        isJoined?: boolean;
        joinRule?: PublicChannelJoinRule;
        limit?: number;
        nextToken?: string;
        order: ChannelSortOrder;
        searchTerm?: string;
        tags?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    handleId isJoined? joinRule? limit? nextToken? order searchTerm? tags?

    Properties

    handleId: HandleId

    Identifier of the handle owned by this client.

    isJoined?: boolean

    Optional flag to only return joined channels when true or not yet joined channels when false. If undefined, the flag is not applied to the search.

    joinRule?: PublicChannelJoinRule

    Optional filter by PUBLIC_WITH_INVITE or PUBLIC or undefined if join rule should not be applied to the search.

    limit?: number

    Number of items to return. Will be defaulted if omitted.

    nextToken?: string

    A token generated by a previous call.

    order: ChannelSortOrder

    Specifies the ordering that should be applied to the channels returned by the search.

    searchTerm?: string

    Optional string to search metadata such as name, description, alias etc. or undefined if a search term should not be applied to the search.

    tags?: string[]

    Optional array of tags to match or undefined if the tags should not be applied to the search. At least one match is required for a result to be returned.

    Settings

    Member Visibility

    On This Page

    Properties