list method

Future<Aliases> list(
  1. String userKey, {
  2. String? event,
  3. String? $fields,
})

Lists all aliases for a user.

Request parameters:

userKey - Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.

event - Events to watch for. Possible string values are:

  • "add" : Alias Created Event
  • "delete" : Alias Deleted Event

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

Completes with a Aliases.

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

  final url_ = 'admin/directory/v1/users/' +
      commons.escapeVariable('$userKey') +
      '/aliases';

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