$templates_Request method

  1. @experimental
Request $templates_Request({
  1. required String editorId,
  2. required String creatorId,
  3. bool? oCSAPIRequest,
})

Get the templates for direct editing.

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

Parameters:

  • editorId ID of the editor.
  • creatorId ID of the creator.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Templates returned
  • 500

See:

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

Implementation

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

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

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/files/api/v1/directEditing/templates/{editorId}/{creatorId}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.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 _i4.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}