@gphone/sdk
    Preparing search index...

    Function useAppEvents

    • OS Service Hook for events the server pushes to this app.

      appId is required for the same reason useAppLevels and onAppForeground require it: the shell has no way to hand a component its own registry id (§2.7).

      Where you call this decides whether it can miss anything. At module scope — in the app's store, which the registry imports before anything mounts — the subscription is permanent and survives the phone closing, which is what a badgeStore has to be fed from. Inside a component it lives as long as the component, and anything that arrived while it was unmounted is replayed on subscribe.

      One direction only. Apps write through useAppAction and a declared route, unchanged.

      Parameters

      • appId: string

      Returns {
          clear: () => void;
          on: <T = Record<string, unknown>>(
              event: string,
              handler: (e: AppEvent<T>) => void,
          ) => () => void;
          onAny: (handler: (e: AppEvent) => void) => () => void;
      }

      • clear: () => void

        Drop anything buffered, once a fetch has made it redundant.

      • on: <T = Record<string, unknown>>(
            event: string,
            handler: (e: AppEvent<T>) => void,
        ) => () => void

        T is an assertion, not a check. The bus guarantees payload is a plain object and nothing more; narrow it yourself.

      • onAny: (handler: (e: AppEvent) => void) => () => void

    Settings
    Member Visibility