registerDevice method

Future<DynamiteResponse<PushRegisterDeviceResponseApplicationJson, void>> registerDevice({
  1. required PushRegisterDeviceRequestApplicationJson $body,
  2. PushRegisterDeviceApiVersion? apiVersion,
  3. 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:

  • 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<_i1.DynamiteResponse<PushRegisterDeviceResponseApplicationJson, void>> registerDevice({
  required PushRegisterDeviceRequestApplicationJson $body,
  PushRegisterDeviceApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $registerDevice_Request(
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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