Show / Hide Table of Contents

    Class PushNotificationUpdateType

    Types of PushNotificationUpdate that can be sent via push notification to Sensus.

    Inheritance
    System.Object
    PushNotificationUpdateType
    Namespace: Sensus.Notifications
    Assembly: SensusAndroid.dll
    Syntax
    public sealed class PushNotificationUpdateType : Enum

    Fields

    Callback

    The Content value contains information about a ScheduledCallback that needs to run.

    Declaration
    public const PushNotificationUpdateType Callback
    Field Value
    Type Description
    PushNotificationUpdateType

    ClearPushNotificationRequestBacklog

    The Content value will be empty. This type of PushNotificationUpdate indicates that the app should attempt to clear its backlog of pending push notification requests. This is important due to background termination and resumption dynamics on iOS. iOS will typically terminate the app overnight and during other periods of prolonged phone inactivity. At some point, iOS will then let a push notification through, which will relaunch the app into the background. Because the relaunch occurs in the background, limited time is provided to the app. In response, we avoid performing certain long-running operations like the submission of push notification requests. We hold on to these requests and let the app relaunch as quickly as possible. However, because the push notification requests are held back, subsequent push notifications will be discontinued thus cutting off most periodic operations of the app. The push notification backend is therefore configured to periodically send an update with this type. Upon receipt, the app will attempt to clear the backlog of push notifications that have been held back and thereby resume normal operation.

    Declaration
    public const PushNotificationUpdateType ClearPushNotificationRequestBacklog
    Field Value
    Type Description
    PushNotificationUpdateType

    Protocol

    The Content value contains new settings for the Protocol. These new settings have the following fields:

      • property-type: The fully qualified name of the type defining the property to be updated. For example, Sensus.Probes.PollingProbe contains properties that govern the behavior of all polling-style probes.
      • property-name: The name of the property within the type indicated by property-type that should be set. For example, Sensus.Probes.PollingProbe.PollingSleepDurationMS determines how long the PollingProbe will sleep between taking successive readings.
      • target-type: The fully qualified name of the type whose instances should be updated. For example, a value of Sensus.Probes.Location.PollingLocationProbe would update the property indicated with the previous fields for just the PollingLocationProbe, whereas a value of Sensus.Probes.PollingProbe would update the property for all probes that inherit from PollingProbe.
      • value: Quoted string of the new value to be set for the above property and target objects.
    Declaration
    public const PushNotificationUpdateType Protocol
    Field Value
    Type Description
    PushNotificationUpdateType

    SensingAgentPolicy

    The Content value contains a new policy for the Agent.

    Declaration
    public const PushNotificationUpdateType SensingAgentPolicy
    Field Value
    Type Description
    PushNotificationUpdateType

    SurveyAgentPolicy

    The Content value contains a new policy for the IScriptProbeAgent.

    Declaration
    public const PushNotificationUpdateType SurveyAgentPolicy
    Field Value
    Type Description
    PushNotificationUpdateType

    value__

    Declaration
    public int value__
    Field Value
    Type Description
    System.Int32
    Back to top Copyright © 2014-2018 University of Virginia
    Generated by DocFX