Interface ChannelAPI

Channel API methods

interface ChannelAPI {
    get uploadLogo(): (
        channelId: string,
        file: FileUploadType,
        options?: ImageOptions,
    ) => Promise<void>;
    addMembers(channelId: string, members: Member[]): Promise<void>;
    create(channel: Channel.CreateRequest): Promise<string>;
    delete(channelId: string): Promise<void>;
    list(start?: number, options?: Channel.SearchOptions): ChannelListRequest;
    removeMembers(
        channelId: string,
        members: (string | Member)[],
    ): Promise<void>;
    search(
        searchText?: string,
        options?: AccessEntitySearchOptions<AccessControl.SearchHit> & {
            type?: EntitySearchType;
        },
    ): SearchRequest<AccessControl.SearchHit>;
    update(channelId: string, channel: Channel.CreateRequest): Promise<void>;
}

Hierarchy

  • API
    • ChannelAPI

Accessors

Methods

  • Parameters

    • channelId: string
    • members: Member[]

    Returns Promise<void>

  • Parameters

    • channelId: string

    Returns Promise<void>

  • Parameters

    • channelId: string
    • members: (string | Member)[]

    Returns Promise<void>