Class MembersResource.ListRequest
Retrieves a paginated list of all members in a group.
Inheritance
System.Object
MembersResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Admin.Directory.directory_v1
Assembly: Google.Apis.Admin.Directory.directory_v1.dll
Syntax
public class ListRequest : DirectoryBaseServiceRequest<Members>, IClientServiceRequest<Members>, IClientServiceRequest
Constructors
ListRequest(IClientService, String)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string groupKey)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.String | groupKey |
Properties
GroupKey
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
Declaration
[RequestParameter("groupKey", RequestParameterType.Path)]
public virtual string GroupKey { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Members>.HttpMethod
IncludeDerivedMembership
Whether to list indirect memberships. Default: false.
Declaration
[RequestParameter("includeDerivedMembership", RequestParameterType.Query)]
public virtual bool? IncludeDerivedMembership { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
MaxResults
Maximum number of results to return. Max allowed value is 200.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Members>.MethodName
PageToken
Token to specify next page in the list.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Members>.RestPath
Roles
The roles query parameter allows you to retrieve group members by role. Allowed values are
OWNER, MANAGER, and MEMBER.
Declaration
[RequestParameter("roles", RequestParameterType.Query)]
public virtual string Roles { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Members>.InitParameters()