@amityco/ts-sdk-react-native/src/messageRepository/events/onMessageFlagCleared.ts

Amity Social Cloud Typescript SDK

import { getActiveClient } from '~/client/api';
import { createEventSubscriber } from '~/core/events';
import { ingestInCache } from '~/cache/api/ingestInCache';
import { prepareMessagePayload } from '../utils';

/**
 * ```js
 * import { onMessageFlagCleared } from '@amityco/ts-sdk-react-native'
 * const dispose = onMessageFlagCleared(message => {
 *   // ...
 * })
 * ```
 *
 * Fired when flags have been cleared for a {@link Amity.Message}
 *
 * @param callback The function to call when the event was fired
 * @returns an {@link Amity.Unsubscriber} function to stop listening
 *
 * @category Message Events
 */
export const onMessageFlagCleared = (
  callback: Amity.Listener<Amity.InternalMessage>,
): Amity.Unsubscriber => {
  const client = getActiveClient();

  const filter = async (rawPayload: Amity.MessagePayload) => {
    const payload = await prepareMessagePayload(rawPayload);

    ingestInCache(payload);
    callback(payload.messages[0]);
  };

  return createEventSubscriber(client, 'onMessageFlagCleared', 'message.flagCleared', filter);
};