Show / Hide Table of Contents

Class OtherContactsResource.SearchRequest

Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's names, emailAddresses, and phoneNumbers fields that are from the OTHER_CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchResponse>
PeopleServiceBaseServiceRequest<SearchResponse>
OtherContactsResource.SearchRequest
Implements
IClientServiceRequest<SearchResponse>
IClientServiceRequest
Inherited Members
PeopleServiceBaseServiceRequest<SearchResponse>.Xgafv
PeopleServiceBaseServiceRequest<SearchResponse>.AccessToken
PeopleServiceBaseServiceRequest<SearchResponse>.Alt
PeopleServiceBaseServiceRequest<SearchResponse>.Callback
PeopleServiceBaseServiceRequest<SearchResponse>.Fields
PeopleServiceBaseServiceRequest<SearchResponse>.Key
PeopleServiceBaseServiceRequest<SearchResponse>.OauthToken
PeopleServiceBaseServiceRequest<SearchResponse>.PrettyPrint
PeopleServiceBaseServiceRequest<SearchResponse>.QuotaUser
PeopleServiceBaseServiceRequest<SearchResponse>.UploadType
PeopleServiceBaseServiceRequest<SearchResponse>.UploadProtocol
ClientServiceRequest<SearchResponse>.Execute()
ClientServiceRequest<SearchResponse>.ExecuteAsStream()
ClientServiceRequest<SearchResponse>.ExecuteAsync()
ClientServiceRequest<SearchResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<SearchResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<SearchResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<SearchResponse>.CreateRequest(bool?)
ClientServiceRequest<SearchResponse>.GenerateRequestUri()
ClientServiceRequest<SearchResponse>.GetBody()
ClientServiceRequest<SearchResponse>.GetDefaultETagAction(string)
ClientServiceRequest<SearchResponse>.ETagAction
ClientServiceRequest<SearchResponse>.ModifyRequest
ClientServiceRequest<SearchResponse>.ValidateParameters
ClientServiceRequest<SearchResponse>.ApiVersion
ClientServiceRequest<SearchResponse>.RequestParameters
ClientServiceRequest<SearchResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class OtherContactsResource.SearchRequest : PeopleServiceBaseServiceRequest<SearchResponse>, IClientServiceRequest<SearchResponse>, IClientServiceRequest

Constructors

SearchRequest(IClientService)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchResponse>.MethodName

PageSize

Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.

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

Query

Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".

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

ReadMask

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: * emailAddresses * metadata * names * phoneNumbers

Declaration
[RequestParameter("readMask", RequestParameterType.Query)]
public virtual object ReadMask { get; set; }
Property Value
Type Description
object

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchResponse>.RestPath

Methods

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides
PeopleServiceBaseServiceRequest<SearchResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX