checkFreeAccess method

Future<CheckFreeAccessResponse> checkFreeAccess(
  1. String name, {
  2. String? httpReferrer,
  3. String? uri,
  4. String? $fields,
})

Checks if a user is eligible for free article access.

Request parameters:

name - Required. The resource name of the publication. Format: publications/{publication_id} Value must have pattern ^publications/\[^/\]+$.

httpReferrer - Required. The HTTP referrer.

uri - Required. The URI of the content.

$fields - Selector specifying which fields to include in a partial response.

Completes with a CheckFreeAccessResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<CheckFreeAccessResponse> checkFreeAccess(
  core.String name, {
  core.String? httpReferrer,
  core.String? uri,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'httpReferrer': ?httpReferrer == null ? null : [httpReferrer],
    'uri': ?uri == null ? null : [uri],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':checkFreeAccess';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return CheckFreeAccessResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}