Interface IPushTargetOutcome

All Known Implementing Classes:
PushTargetOutcomeImpl
public interface IPushTargetOutcome
The outcome of a send for one target: one device subscription, or one live client session reached in-session. An element of IPushSendResult.getTargetOutcomes().
Author:
Christopher Mindus

  • Method Details

    • getUserID

      long getUserID()
      Gets the ID of the user the target belongs to.
      Returns:
      The user ID, IZS.USERS.uid; -1 for the in-session target of a client session without an authenticated user, which sendToClient reaches (ruled 2026-09-26, CC-PUSH-ROADMAP row 3 B).

    • getUserName

      String getUserName()
      Gets the name of the user the target belongs to.
      Returns:
      The user name, never null; empty for the target of a session without an authenticated user.

    • getDeviceUUID

      String getDeviceUUID()
      Gets the device UUID of the target.
      Returns:
      The canonical 36-character UUID, or null for an in-session target whose client session has not reported one.

    • getTransport

      PushTransport getTransport()
      Gets the transport the target was sent through.
      Returns:
      The transport, or null for a target reached or attempted in-session.

    • getAppID

      String getAppID()
      Gets the application ID the target was matched under.
      Returns:
      The canonical application ID, never null.

    • getTopic

      String getTopic()
      Gets the topic the target was matched under.
      Returns:
      The topic, the empty string for the application level; never null.

    • getOutcome

      DeliveryOutcome getOutcome()
      Gets the outcome.
      Returns:
      The outcome, never null.

    • getReason

      String getReason()
      Gets the reason for an outcome that is not a delivery, as the transport or the engine gave it.
      Returns:
      The reason, or null for DeliveryOutcome.DELIVERED and DeliveryOutcome.DELIVERED_IN_SESSION. Never key material.