@amityco/ts-sdk/dist/messageRepository/observers/searchMessage/searchMessage.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { MessageRepository } from '@amityco/ts-sdk';
 *
 * let messages = [];
 *
 * const unsubscribe = MessageRepository.searchMessage(
 *   { query: 'hello' },
 *   response => merge(messages, response.data),
 * );
 * ```
 *
 * Live collection of {@link Amity.Message}s matching the search query. Backed
 * by `GET /api/v2/search/messages`. The first emission delivers the first
 * page; pagination is driven by `response.onNextPage()`.
 *
 * @param params Search parameters. `query` is required.
 * @param callback Called whenever new data are available.
 * @returns An {@link Amity.Unsubscriber} function to stop observing.
 *
 * @category Message Live Collection
 */
export declare const searchMessage: (params: Amity.SearchMessageLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Message>) => Amity.Unsubscriber;
//# sourceMappingURL=searchMessage.d.ts.map