DeviceManager

Methods to register/deregister mobile devices

Methods to register/deregister mobile devices.

Methods

registerDevice()

registerDevice(request): Promise<BWellTransactionResult<DeviceRegistrationResults, BaseManagerError>>

Register device to receive push notifications.

Parameters

request

RegisterDeviceRequest

Request class instance containing device registration information.

Returns

Promise<BWellTransactionResult<DeviceRegistrationResults, BaseManagerError>>

Registration results or an error.

Example

const results = await sdk.device.registerDevice(
  new RegisterDeviceRequest({
    deviceToken: "123",
    platformName: "IOS",
    applicationName: "my-app"
  })
);

deregisterDevice()

deregisterDevice(request): Promise<BWellTransactionResult<DeviceRegistrationResults, BaseManagerError>>

Deregisters a device so that it will no longer receive notifications.

Parameters

request

DeregisterDeviceRequest

Request class instance to deregister the device

Returns

Promise<BWellTransactionResult<DeviceRegistrationResults, BaseManagerError>>

The deregistration results or an error.

Example

const results = await sdk.device.deregisterDevice(
  new DeregisterDeviceRequest({
    deviceToken: "123"
  })
);