Show / Hide Table of Contents

Class Places.PlacesClient

Client for Places

Inheritance
object
ClientBase
ClientBase<Places.PlacesClient>
Places.PlacesClient
Inherited Members
ClientBase<Places.PlacesClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Maps.Places.V1
Assembly: Google.Maps.Places.V1.dll
Syntax
public class Places.PlacesClient : ClientBase<Places.PlacesClient>

Constructors

PlacesClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected PlacesClient()

PlacesClient(CallInvoker)

Creates a new client for Places that uses a custom CallInvoker.

Declaration
public PlacesClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

PlacesClient(ChannelBase)

Creates a new client for Places

Declaration
public PlacesClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

PlacesClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected PlacesClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

AutocompletePlaces(AutocompletePlacesRequest, CallOptions)

Returns predictions for the given input.

Declaration
public virtual AutocompletePlacesResponse AutocompletePlaces(AutocompletePlacesRequest request, CallOptions options)
Parameters
Type Name Description
AutocompletePlacesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AutocompletePlacesResponse

The response received from the server.

AutocompletePlaces(AutocompletePlacesRequest, Metadata, DateTime?, CancellationToken)

Returns predictions for the given input.

Declaration
public virtual AutocompletePlacesResponse AutocompletePlaces(AutocompletePlacesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AutocompletePlacesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AutocompletePlacesResponse

The response received from the server.

AutocompletePlacesAsync(AutocompletePlacesRequest, CallOptions)

Returns predictions for the given input.

Declaration
public virtual AsyncUnaryCall<AutocompletePlacesResponse> AutocompletePlacesAsync(AutocompletePlacesRequest request, CallOptions options)
Parameters
Type Name Description
AutocompletePlacesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<AutocompletePlacesResponse>

The call object.

AutocompletePlacesAsync(AutocompletePlacesRequest, Metadata, DateTime?, CancellationToken)

Returns predictions for the given input.

Declaration
public virtual AsyncUnaryCall<AutocompletePlacesResponse> AutocompletePlacesAsync(AutocompletePlacesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AutocompletePlacesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<AutocompletePlacesResponse>

The call object.

GetPhotoMedia(GetPhotoMediaRequest, CallOptions)

Get a photo media with a photo reference string.

Declaration
public virtual PhotoMedia GetPhotoMedia(GetPhotoMediaRequest request, CallOptions options)
Parameters
Type Name Description
GetPhotoMediaRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
PhotoMedia

The response received from the server.

GetPhotoMedia(GetPhotoMediaRequest, Metadata, DateTime?, CancellationToken)

Get a photo media with a photo reference string.

Declaration
public virtual PhotoMedia GetPhotoMedia(GetPhotoMediaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetPhotoMediaRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
PhotoMedia

The response received from the server.

GetPhotoMediaAsync(GetPhotoMediaRequest, CallOptions)

Get a photo media with a photo reference string.

Declaration
public virtual AsyncUnaryCall<PhotoMedia> GetPhotoMediaAsync(GetPhotoMediaRequest request, CallOptions options)
Parameters
Type Name Description
GetPhotoMediaRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<PhotoMedia>

The call object.

GetPhotoMediaAsync(GetPhotoMediaRequest, Metadata, DateTime?, CancellationToken)

Get a photo media with a photo reference string.

Declaration
public virtual AsyncUnaryCall<PhotoMedia> GetPhotoMediaAsync(GetPhotoMediaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetPhotoMediaRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<PhotoMedia>

The call object.

GetPlace(GetPlaceRequest, CallOptions)

Get the details of a place based on its resource name, which is a string in the places/{place_id} format.

Declaration
public virtual Place GetPlace(GetPlaceRequest request, CallOptions options)
Parameters
Type Name Description
GetPlaceRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Place

The response received from the server.

GetPlace(GetPlaceRequest, Metadata, DateTime?, CancellationToken)

Get the details of a place based on its resource name, which is a string in the places/{place_id} format.

Declaration
public virtual Place GetPlace(GetPlaceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetPlaceRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Place

The response received from the server.

GetPlaceAsync(GetPlaceRequest, CallOptions)

Get the details of a place based on its resource name, which is a string in the places/{place_id} format.

Declaration
public virtual AsyncUnaryCall<Place> GetPlaceAsync(GetPlaceRequest request, CallOptions options)
Parameters
Type Name Description
GetPlaceRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Place>

The call object.

GetPlaceAsync(GetPlaceRequest, Metadata, DateTime?, CancellationToken)

Get the details of a place based on its resource name, which is a string in the places/{place_id} format.

Declaration
public virtual AsyncUnaryCall<Place> GetPlaceAsync(GetPlaceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetPlaceRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Place>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override Places.PlacesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
Places.PlacesClient
Overrides
Grpc.Core.ClientBase<Google.Maps.Places.V1.Places.PlacesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchNearby(SearchNearbyRequest, CallOptions)

Search for places near locations.

Declaration
public virtual SearchNearbyResponse SearchNearby(SearchNearbyRequest request, CallOptions options)
Parameters
Type Name Description
SearchNearbyRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
SearchNearbyResponse

The response received from the server.

SearchNearby(SearchNearbyRequest, Metadata, DateTime?, CancellationToken)

Search for places near locations.

Declaration
public virtual SearchNearbyResponse SearchNearby(SearchNearbyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SearchNearbyRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchNearbyResponse

The response received from the server.

SearchNearbyAsync(SearchNearbyRequest, CallOptions)

Search for places near locations.

Declaration
public virtual AsyncUnaryCall<SearchNearbyResponse> SearchNearbyAsync(SearchNearbyRequest request, CallOptions options)
Parameters
Type Name Description
SearchNearbyRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<SearchNearbyResponse>

The call object.

SearchNearbyAsync(SearchNearbyRequest, Metadata, DateTime?, CancellationToken)

Search for places near locations.

Declaration
public virtual AsyncUnaryCall<SearchNearbyResponse> SearchNearbyAsync(SearchNearbyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SearchNearbyRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<SearchNearbyResponse>

The call object.

SearchText(SearchTextRequest, CallOptions)

Text query based place search.

Declaration
public virtual SearchTextResponse SearchText(SearchTextRequest request, CallOptions options)
Parameters
Type Name Description
SearchTextRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
SearchTextResponse

The response received from the server.

SearchText(SearchTextRequest, Metadata, DateTime?, CancellationToken)

Text query based place search.

Declaration
public virtual SearchTextResponse SearchText(SearchTextRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SearchTextRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchTextResponse

The response received from the server.

SearchTextAsync(SearchTextRequest, CallOptions)

Text query based place search.

Declaration
public virtual AsyncUnaryCall<SearchTextResponse> SearchTextAsync(SearchTextRequest request, CallOptions options)
Parameters
Type Name Description
SearchTextRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<SearchTextResponse>

The call object.

SearchTextAsync(SearchTextRequest, Metadata, DateTime?, CancellationToken)

Text query based place search.

Declaration
public virtual AsyncUnaryCall<SearchTextResponse> SearchTextAsync(SearchTextRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SearchTextRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<SearchTextResponse>

The call object.

In this article
Back to top Generated by DocFX