getShares method

Future<DynamiteResponse<FederationGetSharesResponseApplicationJson, void>> getShares({ FederationGetSharesApiVersion? apiVersion, bool? oCSAPIRequest, })

Get a list of federation invites.

🚧 Draft: Still work in progress.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

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

Status codes:

• 200: Get list of received federation invites successfully

See:

• $getShares_Request for the request send by this method.
• $getShares_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<FederationGetSharesResponseApplicationJson, void>> getShares({
  FederationGetSharesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $getShares_Request(
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $getShares_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<FederationGetSharesResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}