list method

Future<ListUserInvitationsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? orderBy,
  4. int? pageSize,
  5. String? pageToken,
  6. String? $fields,
})

Retrieves a list of UserInvitation resources.

Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

Request parameters:

parent - Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with. Value must have pattern ^customers/\[^/\]+$.

filter - Optional. A query string for filtering UserInvitation results by their current state, in the format: "state=='invited'".

orderBy - Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using order_by="email desc". Currently, sorting is supported for update_time asc, update_time desc, email asc, and email desc. If not specified, results will be returned based on email asc order.

pageSize - Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.

pageToken - Optional. A page token, received from a previous ListUserInvitations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

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

Completes with a ListUserInvitationsResponse.

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<ListUserInvitationsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/userinvitations';

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