Interface Push

Enables a device to be registered and deregistered from receiving push notifications.

Hierarchy

  • Push

Properties

Methods

Properties

admin: PushAdmin

A PushAdmin object.

Methods

  • Activates the device for push notifications. Subsequently registers the device with Ably and stores the deviceIdentityToken in local storage.

    Parameters

    • Optional registerCallback: RegisterCallback

      A function passed to override the default implementation to register the local device for push activation.

    • Optional updateFailedCallback: ErrorCallback

      A callback to be invoked when the device registration failed to update.

    Returns Promise<void>

  • Deactivates the device from receiving push notifications.

    Parameters

    • deregisterCallback: DeregisterCallback

      A function passed to override the default implementation to deregister the local device for push activation.

    Returns Promise<void>

Generated using TypeDoc