registerDevice method

Future<DynamiteResponse<PushRegisterDeviceResponseApplicationJson, void>> registerDevice({
  1. required String pushTokenHash,
  2. required String devicePublicKey,
  3. required String proxyServer,
  4. PushRegisterDeviceApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Register device for push notifications.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • pushTokenHash Hash of the push token.
  • devicePublicKey Public key of the device.
  • proxyServer Proxy server to be used.
  • apiVersion Defaults to v2.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Device was already registered
  • 201: Device registered successfully
  • 400: Registering device is not possible
  • 401: Missing permissions to register device

See:

Implementation

Future<DynamiteResponse<PushRegisterDeviceResponseApplicationJson, void>> registerDevice({
  required String pushTokenHash,
  required String devicePublicKey,
  required String proxyServer,
  PushRegisterDeviceApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = registerDeviceRaw(
    pushTokenHash: pushTokenHash,
    devicePublicKey: devicePublicKey,
    proxyServer: proxyServer,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}