$index_Request method

@experimental Request $index_Request({ bool? oCSAPIRequest, })

api v2 Get all contexts available to the requesting person.

Return an empty array if no contexts were found.

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

Parameters:

• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: reporting in available contexts
• 500

See:

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

Implementation

@_i2.experimental
_i3.Request $index_Request({bool? oCSAPIRequest}) {
  const _path = '/ocs/v2.php/apps/tables/api/2/contexts';
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _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);

  return _request;
}