getIdForEmail method

Future<PermissionId> getIdForEmail(
  1. String email, {
  2. String? $fields,
})

Returns the permission ID for an email address.

Request parameters:

email - The email address for which to return a permission ID

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

Completes with a PermissionId.

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<PermissionId> getIdForEmail(
  core.String email, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'permissionIds/' + commons.escapeVariable('$email');

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