@amityco/ts-sdk/dist/channelRepository/observers/searchChannels.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { ChannelRepository } from '@amityco/ts-sdk';
 *
 * const unsubscribe = ChannelRepository.searchChannels(
 *   { query: 'hello' },
 *   response => response.data,
 * );
 * ```
 *
 * Live collection of {@link Amity.Channel}s matching the search query. Backed by
 * `GET /api/v2/search/channels`.
 *
 * @param params Search parameters.
 * @param callback Called whenever new data are available.
 * @returns An {@link Amity.Unsubscriber} function to stop observing.
 *
 * @category Channel Live Collection
 */
export declare const searchChannels: (params: Amity.SearchChannelLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Channel>) => Amity.Unsubscriber;
//# sourceMappingURL=searchChannels.d.ts.map