$getShare_Request method

  1. @experimental
Request $getShare_Request({
  1. required int shareId,
})

Get a share object.

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

Parameters:

  • shareId Share ID.

Status codes:

  • 200: Share returned
  • 403: No permissions
  • 500
  • 404: Not found

See:

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

Implementation

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

  final _path = _i5.UriTemplate('/index.php/apps/tables/api/1/shares/{shareId}').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 = _i4.IterableExtension(_rootClient.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;
}