Game.subscribeInfoOverlayHidden

Feature description

Subscribe to the moment when the game info overlay has completely disappeared. Events occur only in games where the game info overlay is displayed.

You must subscribe before the overlay disappears. Already missed events will not be delivered again. Call the returned unsubscribe function when you no longer need events.

Type

Params

interface SubscribeInfoOverlayHiddenEventParams {
  onEvent: () => void;
  onError: (error: unknown) => void;
}

Response

type Unsubscribe = () => void;

Example code

import { Game } from "@apps-in-toss/web-framework";

const unsubscribe = Game.subscribeInfoOverlayHidden({
  onEvent: () => {
    console.log("The game info overlay has disappeared.");
  },
  onError: (error) => {
    console.error("Could not subscribe to the game info overlay event.", error);
  },
});

// Call when you no longer need events.
unsubscribe();