Interface IAppSessionPushNotificationAPI

Method Details

• sendToUser

  void sendToUser(IPushNotification notification, String topic, PushSendOptions options, BiFunction<IPushSendResult, Exception, Void> callback)

  Sends a notification to the session's user on every device subscribed for this application and topic, and in-session to every connected client session of that user when the delivery mode allows it - for a topic other than the empty string, only when the user holds a subscription for it (ruled 2026-09-26, CC-PUSH-ROADMAP row 2 B).

  Parameters:

  notification - The notification, built with IPushNotificationMessageBuilder.

  topic - The topic, the empty string for the application-level subscription.

  options - The time-to-live, urgency and delivery mode, or null for every default.

  callback - Called on the application session's worker thread with the result and its per-device outcomes, or with the failure; a session with no authenticated user fails with the reason no_user.

  Throws:

  NullPointerException - If notification, topic or callback is null.

• sendToUsers

  void sendToUsers(Collection<String> recipients, IPushNotification notification, String topic, PushSendOptions options, BiFunction<IPushSendResult, Exception, Void> callback)

  Sends a notification to the named users on every device subscribed for this application and topic, and in-session to each named user's connected client sessions when the delivery mode allows it - for a topic other than the empty string, only when that user holds a subscription for it (ruled 2026-09-26, CC-PUSH-ROADMAP row 2 B).

  Parameters:

  recipients - User names or e-mail addresses, matched case-insensitively; at least one. A name that matches no user is reported as no outcome rather than as a failure. The wildcard * is not accepted here: a broadcast is sendToTopic(String, IPushNotification, PushSendOptions, BiFunction), so "everyone" is never the accident of an empty or wildcard list.

  notification - The notification, built with IPushNotificationMessageBuilder.

  topic - The topic, the empty string for the application-level subscription.

  options - The time-to-live, urgency and delivery mode, or null for every default.

  callback - Called on the application session's worker thread with the result and its per-device outcomes, or with the failure.

  Throws:

  NullPointerException - If recipients, notification, topic or callback is null.

  IllegalArgumentException - If recipients is empty or contains *.

• sendToTopic

  void sendToTopic(String topic, IPushNotification notification, PushSendOptions options, BiFunction<IPushSendResult, Exception, Void> callback)

  Sends a notification to every subscriber of this application and topic, whoever they are. In-session it reaches the connected client sessions of the users subscribed to that topic; the empty string reaches every connected client session of the application, subscribed or not (ruled 2026-09-26, CC-PUSH-ROADMAP row 2 B). A session without an authenticated user is never reached by a fan-out (row 3 B); sendToClient(IClientSessionGyro, IPushNotification, String, PushSendOptions, BiFunction) is how it is reached.

  Parameters:

  topic - The topic, the empty string for the application-level subscribers.

  notification - The notification, built with IPushNotificationMessageBuilder.

  options - The time-to-live, urgency and delivery mode, or null for every default.

  callback - Called on the application session's worker thread with the result and its per-device outcomes, or with the failure.

  Throws:

  NullPointerException - If topic, notification or callback is null.

• countSubscriptions

  void countSubscriptions(String topic, BiFunction<Integer, Exception, Void> callback)

  Counts the subscriptions of this application and topic, of every user: what sendToTopic(String, IPushNotification, PushSendOptions, BiFunction) would match now.

  Parameters:

  topic - The topic, the empty string for the application-level subscriptions, or null for every topic.

  callback - Called on the application session's worker thread with the count, or with the failure.

  Throws:

  NullPointerException - If callback is null.

• queryDeviceState

  void queryDeviceState(IClientSessionGyro client, BiFunction<IPushDeviceState, Exception, Void> callback)

  Queries the Push Notification state of a client's device, as IPushNotificationAPI.queryDeviceState(BiFunction) does.

  Parameters:

  client - A client session of this application session.

  callback - Called on the application session's worker thread with the state, or with the failure.

  Throws:

  NullPointerException - If client or callback is null.

  IllegalArgumentException - If client belongs to another application session.

• subscribe

  void subscribe(IClientSessionGyro client, String topic, BiFunction<IPushSubscribeResult, Exception, Void> callback)

  Subscribes a client's device, as IPushNotificationAPI.subscribe(String, BiFunction) does, with the same user-gesture rule: on a Browser the call succeeds only when the user has already granted notifications, and fails gesture_required at once otherwise - the first subscription of a Browser user comes from a click on the subscribe action (P4-09), never from a server call (ruled 2026-09-24, RR-8 A and RR-9 A) - and with the same reasons otherwise.

  Parameters:

  client - A client session of this application session.

  topic - The topic, the empty string for the application-level subscription.

  callback - Called on the application session's worker thread with the result, or with the failure.

  Throws:

  NullPointerException - If client, topic or callback is null.

  IllegalArgumentException - If client belongs to another application session.

• unsubscribe

  void unsubscribe(IClientSessionGyro client, String topic, BiFunction<Integer, Exception, Void> callback)

  Unsubscribes a client's device, as IPushNotificationAPI.unsubscribe(String, BiFunction) does: the row on this server first, then the device's subscription once no row of this application remains.

  Parameters:

  client - A client session of this application session.

  topic - The topic, the empty string for the application-level subscription.

  callback - Called on the application session's worker thread with the number of subscriptions removed, or with the failure.

  Throws:

  NullPointerException - If client, topic or callback is null.

  IllegalArgumentException - If client belongs to another application session.

• resetDevice

  void resetDevice(IClientSessionGyro client, BiFunction<Integer, Exception, Void> callback)

  Removes every subscription of the user on a client's device for this application, as IPushNotificationAPI.resetDevice(BiFunction) does (ruled 2026-09-24, RR-15 B): other applications' rows survive.

  Parameters:

  client - A client session of this application session.

  callback - Called on the application session's worker thread with the number of subscriptions removed, or with the failure.

  Throws:

  NullPointerException - If client or callback is null.

  IllegalArgumentException - If client belongs to another application session.

• resetDeviceEverywhere

  void resetDeviceEverywhere(IClientSessionGyro client, BiFunction<Integer, Exception, Void> callback)

  Removes every subscription of the user on a client's device for every application, as IPushNotificationAPI.resetDeviceEverywhere(BiFunction) does (ruled 2026-09-25, P4-b): the HTTP reset with an empty body, what iiziRun's Reset does on the server.

  Parameters:

  client - A client session of this application session.

  callback - Called on the application session's worker thread with the number of subscriptions removed, or with the failure.

  Throws:

  NullPointerException - If client or callback is null.

  IllegalArgumentException - If client belongs to another application session.

• sendToClient

  void sendToClient(IClientSessionGyro client, IPushNotification notification, String topic, PushSendOptions options, BiFunction<IPushSendResult, Exception, Void> callback)

  Sends a notification to one client's device only, as IPushNotificationAPI.sendToClient(IPushNotification, String, PushSendOptions, BiFunction) does.

  Parameters:

  client - A client session of this application session.

  notification - The notification, built with IPushNotificationMessageBuilder.

  topic - The topic, the empty string for the application-level subscription.

  options - The time-to-live, urgency and delivery mode, or null for every default.

  callback - Called on the application session's worker thread with the result, or with the failure.

  Throws:

  NullPointerException - If client, notification, topic or callback is null.

  IllegalArgumentException - If client belongs to another application session.