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

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { ChannelRepository } from '@amityco/ts-sdk'
 *
 * let channels = []
 * const unsub = ChannelRepository.getArchivedChannels(params, response => merge(channels, response.data))
 * ```
 *
 * Live collection of {@link Amity.Channel}s archived by the active user.
 *
 * @param params Live collection parameters (only `limit` is honored; the
 * archive list takes no other filters).
 * @param callback the function to call when new data are available
 * @returns An {@link Amity.Unsubscriber} function to run when willing to
 * stop observing.
 *
 * @category Channel Live Collection
 */
export declare const getArchivedChannels: (params: Amity.ArchivedChannelLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Channel>) => () => void;
//# sourceMappingURL=getArchivedChannels.d.ts.map