$registerDevice_Request method

  1. @experimental
Request $registerDevice_Request({
  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 DynamiteRequest backing the registerDevice operation. 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

@_i2.experimental
_i3.Request $registerDevice_Request({
  required String pushTokenHash,
  required String devicePublicKey,
  required String proxyServer,
  PushRegisterDeviceApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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;

  final _path = _i4.UriTemplate(
    '/ocs/v2.php/apps/notifications/api/{apiVersion}/push{?pushTokenHash*,devicePublicKey*,proxyServer*}',
  ).expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i5.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}