Class DeviceInformationChange`Abstract`

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)

HttpOperation<DeviceInformationChange>
- DeviceInformationChange

Index

Methods

name fcmRegistrationToken disablePushNotifications retryPolicy onSuccess onError requestHeaders execute

Methods

`Abstract`name

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.

`Abstract`fcmRegistrationToken

fcmRegistrationToken(fcmRegistrationToken: string): DeviceInformationChange
Specifies the new Firebase Cloud Messaging registration token.

Important
Do not invoke this method if the Firebase Cloud Messaging registration token does not need to be updated.
Parameters
- fcmRegistrationToken: string
  the new Firebase Cloud Messaging registration token.
Returns DeviceInformationChange
a DeviceInformationChange object.

`Abstract`disablePushNotifications

disablePushNotifications(): DeviceInformationChange
Disables the push notifications on the server side (i.e. the server will not send authentication push notifications).

To re-enable the sending of push notifications, execute a DeviceInformationChange and provide the Firebase Cloud Messaging registration token through the method fcmRegistrationToken.

Returns DeviceInformationChange
a DeviceInformationChange object.

`Abstract`retryPolicy

retryPolicy(retryPolicy: RetryPolicy): DeviceInformationChange
Specifies the retry policy to be used.

For some errors (such as networking errors) retrying is meaningful, this parameter specifies the retry policy to be followed if one of these errors occurs.

If no retry policy is provided NoRetryPolicy will be used.
Parameters
- retryPolicy: RetryPolicy
  the retry policy.
Returns DeviceInformationChange
a DeviceInformationChange object.

`Abstract`onSuccess

onSuccess(onSuccess: () => void): DeviceInformationChange
Specifies the object that will be invoked if the device information for the user was updated successfully.

Important
Providing the onSuccess callback is required.
Parameters
- onSuccess: () => void
  the function which is invoked on successful update.
Returns DeviceInformationChange
a DeviceInformationChange object.

`Abstract`onError

onError(
onError: (error: DeviceInformationChangeError) => void,
): DeviceInformationChange
Specifies the object that will be invoked if the dispatch device information change failed.

Important
Providing the onError callback is required.
Parameters
- onError: (error: DeviceInformationChangeError) => void
  the function which receives a DeviceInformationChangeError.
Returns DeviceInformationChange
a DeviceInformationChange object.

`Abstract`requestHeaders

requestHeaders(requestHeaders: RequestHeaders): DeviceInformationChange
Specifies the additional request headers that must be included in the HTTP requests sent by the operation.
Parameters
- requestHeaders: RequestHeaders
  the HTTP headers.
Returns DeviceInformationChange
an HttpOperation object.

Inherited from HttpOperation.requestHeaders

`Abstract`execute

execute(): Promise<void>
Executes the operation asynchronously.

Returns Promise<void>
Inherited from HttpOperation.execute

Class DeviceInformationChange`Abstract`

Hierarchy (View Summary)

Index

Methods

Methods

`Abstract`name

Parameters

Returns DeviceInformationChange

`Abstract`fcmRegistrationToken

Parameters

Returns DeviceInformationChange

`Abstract`disablePushNotifications

Returns DeviceInformationChange

`Abstract`retryPolicy

Parameters

Returns DeviceInformationChange

`Abstract`onSuccess

Parameters

Returns DeviceInformationChange

`Abstract`onError

Parameters

Returns DeviceInformationChange

`Abstract`requestHeaders

Parameters

Returns DeviceInformationChange

`Abstract`execute

Returns Promise<void>

Settings

On This Page

Class DeviceInformationChangeAbstract

Hierarchy (View Summary)

Index

Methods

Methods

Abstractname

Parameters

Returns DeviceInformationChange

AbstractfcmRegistrationToken

Parameters

Returns DeviceInformationChange

AbstractdisablePushNotifications

Returns DeviceInformationChange

AbstractretryPolicy

Parameters

Returns DeviceInformationChange

AbstractonSuccess

Parameters

Returns DeviceInformationChange

AbstractonError

Parameters

Returns DeviceInformationChange

AbstractrequestHeaders

Parameters

Returns DeviceInformationChange

Abstractexecute

Returns Promise<void>

Settings

On This Page

Class DeviceInformationChange`Abstract`

`Abstract`name

`Abstract`fcmRegistrationToken

`Abstract`disablePushNotifications

`Abstract`retryPolicy

`Abstract`onSuccess

`Abstract`onError

`Abstract`requestHeaders

`Abstract`execute