registerDevice method

Future<DynamiteResponse<PushRegisterDeviceResponseApplicationJson, void>> registerDevice({ required String pushTokenHash, required String devicePublicKey, required String proxyServer, PushRegisterDeviceApiVersion? apiVersion, 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:

• $registerDevice_Request for the request send by this method.
• $registerDevice_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<PushRegisterDeviceResponseApplicationJson, void>> registerDevice({
  required String pushTokenHash,
  required String devicePublicKey,
  required String proxyServer,
  PushRegisterDeviceApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $registerDevice_Request(
    pushTokenHash: pushTokenHash,
    devicePublicKey: devicePublicKey,
    proxyServer: proxyServer,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $registerDevice_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<PushRegisterDeviceResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}