$$update_Request method

  1. @experimental
Request $$update_Request({
  1. required int contextId,
  2. bool? oCSAPIRequest,
  3. ContextUpdateRequestApplicationJson? $body,
})

api v2 Update an existing context and return it.

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

Parameters:

  • contextId ID of the context.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: returning the full context information
  • 500
  • 404: Not found
  • 403: No permissions

See:

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

Implementation

@_i2.experimental
_i3.Request $$update_Request({
  required int contextId,
  bool? oCSAPIRequest,
  ContextUpdateRequestApplicationJson? $body,
}) {
  final _parameters = <String, Object?>{};
  final __contextId = _$jsonSerializers.serialize(contextId, specifiedType: const FullType(int));
  _parameters['contextId'] = __contextId;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/tables/api/2/contexts/{contextId}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_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 _i6.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = $body != null
      ? json.encode(
          _$jsonSerializers.serialize($body, specifiedType: const FullType(ContextUpdateRequestApplicationJson)),
        )
      : json.encode(
          _$jsonSerializers.serialize(
            ContextUpdateRequestApplicationJson(),
            specifiedType: const FullType(ContextUpdateRequestApplicationJson),
          ),
        );
  return _request;
}