@ably/chat/src/react/types/status-params.ts

Ably Chat is a set of purpose-built APIs for a host of chat features enabling you to create 1:1, 1:Many, Many:1 and Many:Many chat rooms for any scale. It is designed to meet a wide range of chat use cases, such as livestreams, in-game communication, cust

import { ConnectionStatusChange } from '../../core/connection.js';
import { DiscontinuityListener } from '../../core/discontinuity.js';
import { RoomStatusChange } from '../../core/room-status.js';

/**
 * Parameters for registering callbacks to receive status changes from
 * different chat features.
 *
 * Most hooks provided in this library accept this parameter to allow you to
 * listen to status changes.
 *
 * It's an alternative to {@link ChatStatusResponse} which provide this
 * information via a callback.
 *
 * Changing the value provided for each of the available listeners will cause the previously registered listener instance
 * to stop receiving events. However, all message events will be received by exactly one listener.
 */
export interface StatusParams {
  /**
   * Register a callback for when the room status changes.
   * @param change Object representing the change in room status.
   */
  onRoomStatusChange?: (change: RoomStatusChange) => void;

  /**
   * Register a callback for when the connection status to Ably changes.
   * @param change Object representing the change in connection status.
   */
  onConnectionStatusChange?: (change: ConnectionStatusChange) => void;

  /**
   * Register a callback to detect and respond to discontinuities. For example,
   * you might choose to fetch missing messages.
   * @param error The error that caused the discontinuity.
   */
  onDiscontinuity?: DiscontinuityListener;
}