Show / Hide Table of Contents

Class PeopleResource.ListRequest

List all of the people in the specified collection.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<PeopleFeed>
PlusBaseServiceRequest<PeopleFeed>
PeopleResource.ListRequest
Implements
IClientServiceRequest<PeopleFeed>
IClientServiceRequest
Inherited Members
PlusBaseServiceRequest<PeopleFeed>.Alt
PlusBaseServiceRequest<PeopleFeed>.Fields
PlusBaseServiceRequest<PeopleFeed>.Key
PlusBaseServiceRequest<PeopleFeed>.OauthToken
PlusBaseServiceRequest<PeopleFeed>.PrettyPrint
PlusBaseServiceRequest<PeopleFeed>.QuotaUser
PlusBaseServiceRequest<PeopleFeed>.UserIp
ClientServiceRequest<PeopleFeed>.Execute()
ClientServiceRequest<PeopleFeed>.ExecuteAsStream()
ClientServiceRequest<PeopleFeed>.ExecuteAsync()
ClientServiceRequest<PeopleFeed>.ExecuteAsync(CancellationToken)
ClientServiceRequest<PeopleFeed>.ExecuteAsStreamAsync()
ClientServiceRequest<PeopleFeed>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<PeopleFeed>.CreateRequest(Nullable<Boolean>)
ClientServiceRequest<PeopleFeed>.GenerateRequestUri()
ClientServiceRequest<PeopleFeed>.GetBody()
ClientServiceRequest<PeopleFeed>.GetDefaultETagAction(String)
ClientServiceRequest<PeopleFeed>.ETagAction
ClientServiceRequest<PeopleFeed>.ModifyRequest
ClientServiceRequest<PeopleFeed>.RequestParameters
ClientServiceRequest<PeopleFeed>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
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.Plus.v1
Assembly: Google.Apis.Plus.v1.dll
Syntax
public class ListRequest : PlusBaseServiceRequest<PeopleFeed>, IClientServiceRequest<PeopleFeed>, IClientServiceRequest

Constructors

ListRequest(IClientService, String, PeopleResource.ListRequest.CollectionEnum)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string userId, PeopleResource.ListRequest.CollectionEnum collection)
Parameters
Type Name Description
IClientService service
System.String userId
PeopleResource.ListRequest.CollectionEnum collection

Properties

Collection

The collection of people to list.

Declaration
[RequestParameter("collection", RequestParameterType.Path)]
public virtual PeopleResource.ListRequest.CollectionEnum Collection { get; }
Property Value
Type Description
PeopleResource.ListRequest.CollectionEnum

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Plus.v1.Data.PeopleFeed>.HttpMethod

MaxResults

The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Plus.v1.Data.PeopleFeed>.MethodName

OrderBy

The order to return people in.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual PeopleResource.ListRequest.OrderByEnum? OrderBy { get; set; }
Property Value
Type Description
System.Nullable<PeopleResource.ListRequest.OrderByEnum>

PageToken

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

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.Plus.v1.Data.PeopleFeed>.RestPath

UserId

Get the collection of people for the person identified. Use "me" to indicate the authenticated user.

Declaration
[RequestParameter("userId", RequestParameterType.Path)]
public virtual string UserId { get; }
Property Value
Type Description
System.String

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Plus.v1.PlusBaseServiceRequest<Google.Apis.Plus.v1.Data.PeopleFeed>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
Back to top