$syncDevice_Request method

  1. @experimental
Request $syncDevice_Request({
  1. required String deviceId,
})

Request to get push messages.

This is a public page since it has to be handle by the non-connected app (NextPush app and not Nextcloud-app).

Returns a DynamiteRequest backing the syncDevice operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Status codes:

  • 401: Missing permissions to sync device

See:

  • syncDevice for a method executing this request and parsing the response.
  • $syncDevice_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $syncDevice_Request({required String deviceId}) {
  final _parameters = <String, Object?>{};
  final $deviceId = _$jsonSerializers.serialize(deviceId, specifiedType: const FullType(String));
  _parameters['deviceId'] = $deviceId;

  final _path = _i4.UriTemplate('/index.php/apps/uppush/device/{deviceId}').expand(_parameters);
  final _uri = Uri.parse('$baseURL$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  return _request;
}