Class PeopleResource.ConnectionsResource.ListRequest

Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an google.rpc.ErrorInfo with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the sync_token is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted set to true. When the page_token or sync_token is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at List the user's contacts that have changed.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListConnectionsResponse>
PeopleServiceBaseServiceRequest<ListConnectionsResponse>
PeopleResource.ConnectionsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class PeopleResource.ConnectionsResource.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
string resourceName

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
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
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 1000, 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
int?

PageToken

Optional. A page token, received from a previous response next_page_token. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to people.connections.list must match the first call that provided the page token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
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 * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Declaration
[RequestParameter("personFields", RequestParameterType.Query)]
public virtual object PersonFields { get; set; }
Property Value
Type Description
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
object

RequestSyncToken

Optional. Whether the response should return next_sync_token on the last page of results. It can be used to get incremental changes since the last request by setting it on the request sync_token. More details about sync behavior at people.connections.list.

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

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
string

RestPath

Gets the REST path.

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

SortOrder

Optional. 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
PeopleResource.ConnectionsResource.ListRequest.SortOrderEnum?

Sources

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual PeopleResource.ConnectionsResource.ListRequest.SourcesEnum? Sources { get; set; }
Property Value
Type Description
PeopleResource.ConnectionsResource.ListRequest.SourcesEnum?
Remarks

Use this property to set a single value for the parameter, or SourcesList to set multiple values. Do not set both properties.

SourcesList

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual Repeatable<PeopleResource.ConnectionsResource.ListRequest.SourcesEnum> SourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.ConnectionsResource.ListRequest.SourcesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Sources.

SyncToken

Optional. A sync token, received from a previous response next_sync_token Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to people.connections.list must match the first call that provided the sync token. More details about sync behavior at people.connections.list.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements