Class DeviceInformationChangeAbstract

The object that changes the device information.

The device information change can be used to

  • modify the name of the device and/or
  • modify its Firebase registration token or
  • disable push notifications.

If neither name or fcmRegistrationToken are provided, the provided onSuccess callback will be executed when execute is invoked.

Usage example for changing device information:

  [...]
  async updateDeviceInformation(
      client: MobileAuthenticationClient,
      newName: string,
      fcmToken: string
  ): Promise<void> {
      await client.operations.deviceInformationChange
          .name(newName)
          .fcmRegistrationToken(fcmToken)
          .onSuccess(() => {
              // handle success
          })
          .onError((_error) => {
              // handle error
          })
          .execute();
  }
  [...]

Hierarchy (View Summary)

Methods

name fcmRegistrationToken disablePushNotifications retryPolicy onSuccess onError requestHeaders execute

Methods

Abstractname

  • name(name: string): DeviceInformationChange

  • Specifies the new name of the device information.

    This is typically a user-friendly string describing the mobile device where the application is running.

    IMPORTANT
    Do not invoke this method if the name does not need to be updated.

    Parameters

    • name: string

      the new device information name.

    Returns DeviceInformationChange

    a DeviceInformationChange object.

AbstractfcmRegistrationToken

AbstractdisablePushNotifications

AbstractretryPolicy

AbstractonSuccess

AbstractonError

AbstractrequestHeaders

Abstractexecute

  • execute(): Promise<void>

  • Executes the operation asynchronously.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods