$push_Request method

  1. @experimental
Request $push_Request({
  1. required String token,
})

Receive notifications from 3rd parties.

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

Status codes:

  • 201: Notification pushed successfully

See:

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

Implementation

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

  final _path = _i4.UriTemplate('/index.php/apps/uppush/push/{token}').expand(_parameters);
  final _uri = Uri.parse('$baseURL$_path');
  final _request = _i3.Request('post', _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;
}