registerDeviceRaw method

  1. @experimental
DynamiteRawResponse<PushRegisterDeviceResponseApplicationJson, void> registerDeviceRaw({
  1. required String pushTokenHash,
  2. required String devicePublicKey,
  3. required String proxyServer,
  4. PushRegisterDeviceApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Register device for push notifications.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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

@experimental
DynamiteRawResponse<PushRegisterDeviceResponseApplicationJson, void> registerDeviceRaw({
  required String pushTokenHash,
  required String devicePublicKey,
  required String proxyServer,
  PushRegisterDeviceApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  final $pushTokenHash = jsonSerializers.serialize(pushTokenHash, specifiedType: const FullType(String));
  _parameters['pushTokenHash'] = $pushTokenHash;

  final $devicePublicKey = jsonSerializers.serialize(devicePublicKey, specifiedType: const FullType(String));
  _parameters['devicePublicKey'] = $devicePublicKey;

  final $proxyServer = jsonSerializers.serialize(proxyServer, specifiedType: const FullType(String));
  _parameters['proxyServer'] = $proxyServer;

  var $apiVersion =
      jsonSerializers.serialize(apiVersion, specifiedType: const FullType(PushRegisterDeviceApiVersion));
  $apiVersion ??= 'v2';
  _parameters['apiVersion'] = $apiVersion;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path = UriTemplate(
    '/ocs/v2.php/apps/notifications/api/{apiVersion}/push{?pushTokenHash*,devicePublicKey*,proxyServer*}',
  ).expand(_parameters);
  return DynamiteRawResponse<PushRegisterDeviceResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200, 201},
    ),
    bodyType: const FullType(PushRegisterDeviceResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}