Class PeopleResource.ConnectionsResource.ListRequest

Provides a list of the authenticated user's contacts merged with any connected profiles.

The request throws a 400 error if 'personFields' is not specified.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListConnectionsResponse>
PeopleServiceBaseServiceRequest<ListConnectionsResponse>
PeopleResource.ConnectionsResource.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.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class ListRequest : PeopleServiceBaseServiceRequest<ListConnectionsResponse>, IClientServiceRequest<ListConnectionsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string resourceName)
Parameters
Type Name Description
IClientService service
System.String resourceName

Properties

HttpMethod

Gets the HTTP method.

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

MethodName

Gets the method name.

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

PageSize

Optional. The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PageToken

The token of the page to be returned.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

PersonFields

Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are:

  • addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
Declaration
[RequestParameter("personFields", RequestParameterType.Query)]
public virtual object PersonFields { get; set; }
Property Value
Type Description
System.Object

RequestMaskIncludeField

Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person.photos.

Declaration
[RequestParameter("requestMask.includeField", RequestParameterType.Query)]
public virtual object RequestMaskIncludeField { get; set; }
Property Value
Type Description
System.Object

RequestSyncToken

Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead. Initial sync requests that specify request_sync_token have an additional rate limit.

Declaration
[RequestParameter("requestSyncToken", RequestParameterType.Query)]
public virtual bool? RequestSyncToken { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ResourceName

Required. The resource name to return connections for. Only people/me is valid.

Declaration
[RequestParameter("resourceName", RequestParameterType.Path)]
public virtual string ResourceName { get; }
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.PeopleService.v1.Data.ListConnectionsResponse>.RestPath

SortOrder

The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.

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

SyncToken

A sync token returned by a previous call to people.connections.list. Only resources changed since the sync token was created will be returned. Sync requests that specify sync_token have an additional rate limit.

Declaration
[RequestParameter("syncToken", RequestParameterType.Query)]
public virtual string SyncToken { get; set; }
Property Value
Type Description
System.String

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.PeopleService.v1.PeopleServiceBaseServiceRequest<Google.Apis.PeopleService.v1.Data.ListConnectionsResponse>.InitParameters()

Implements