Interface IPushSendRequest

All Known Implementing Classes:
PushSendRequest
public interface IPushSendRequest
A complete request to send a notification: what to send, to whom, and under which policies and authority.

Bundles the notification, the target filter, the three per-send policies (each defaulting from IPushSettings when unset here), and the operator's authorization scope. Authorization is assumed, not performed, by the push subsystem: the ServerAdmin application establishes that its caller holds push-admin authority for a set of regions and supplies that scope here; the engine enforces it against the plan but does not decide it.

Author:
IIZI

  • Method Details

    • getNotification

      IPushNotification getNotification()
      Gets the notification to send.
      Returns:
      The notification; never null.

    • getFilter

      ISubscriptionFilter getFilter()
      Gets the filter selecting the target subscriptions (the "group").
      Returns:
      The filter; never null.

    • getResidencyPolicy

      ResidencyPolicy getResidencyPolicy()
      Gets the residency policy for this send, or null to use the server default IPushSettings.getDefaultResidencyPolicy().
      Returns:
      The residency policy, or null for the default.

    • getUrgency

      DeliveryUrgency getUrgency()
      Gets the delivery urgency for this send, or null to use the server default DeliveryUrgency.NORMAL.
      Returns:
      The delivery urgency, or null for the default.

    • getDeliveryMode

      DeliveryMode getDeliveryMode()
      Gets the delivery mode for this send, or null to use the server default IPushSettings.getDefaultDeliveryMode().
      Returns:
      The delivery mode, or null for the default.

    • getAuthorizationScope

      IRegionScope getAuthorizationScope()
      Gets the region scope the issuing operator is authorized for. The engine rejects any matched subscription whose region falls outside this scope as DeliveryOutcome.UNAUTHORIZED_REGION, at plan-build time, before any dispatch.
      Returns:
      The operator's authorization scope; never null.