Represents an AutocompletePlacesRequest.
Package
@googlemaps/placesConstructors
(constructor)(properties)
constructor(properties?: google.maps.places.v1.IAutocompletePlacesRequest);Constructs a new AutocompletePlacesRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAutocompletePlacesRequest
Properties to set |
Properties
includedPrimaryTypes
public includedPrimaryTypes: string[];AutocompletePlacesRequest includedPrimaryTypes.
includedRegionCodes
public includedRegionCodes: string[];AutocompletePlacesRequest includedRegionCodes.
includeQueryPredictions
public includeQueryPredictions: boolean;AutocompletePlacesRequest includeQueryPredictions.
input
public input: string;AutocompletePlacesRequest input.
inputOffset
public inputOffset: number;AutocompletePlacesRequest inputOffset.
languageCode
public languageCode: string;AutocompletePlacesRequest languageCode.
locationBias
public locationBias?: (google.maps.places.v1.AutocompletePlacesRequest.ILocationBias|null);AutocompletePlacesRequest locationBias.
locationRestriction
public locationRestriction?: (google.maps.places.v1.AutocompletePlacesRequest.ILocationRestriction|null);AutocompletePlacesRequest locationRestriction.
origin
public origin?: (google.type.ILatLng|null);AutocompletePlacesRequest origin.
regionCode
public regionCode: string;AutocompletePlacesRequest regionCode.
sessionToken
public sessionToken: string;AutocompletePlacesRequest sessionToken.
Methods
create(properties)
public static create(properties?: google.maps.places.v1.IAutocompletePlacesRequest): google.maps.places.v1.AutocompletePlacesRequest;Creates a new AutocompletePlacesRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAutocompletePlacesRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AutocompletePlacesRequest |
AutocompletePlacesRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.places.v1.AutocompletePlacesRequest;Decodes an AutocompletePlacesRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
AutocompletePlacesRequest |
AutocompletePlacesRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.places.v1.AutocompletePlacesRequest;Decodes an AutocompletePlacesRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AutocompletePlacesRequest |
AutocompletePlacesRequest |
encode(message, writer)
public static encode(message: google.maps.places.v1.IAutocompletePlacesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AutocompletePlacesRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAutocompletePlacesRequest
AutocompletePlacesRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.maps.places.v1.IAutocompletePlacesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AutocompletePlacesRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAutocompletePlacesRequest
AutocompletePlacesRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.maps.places.v1.AutocompletePlacesRequest;Creates an AutocompletePlacesRequest message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
AutocompletePlacesRequest |
AutocompletePlacesRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AutocompletePlacesRequest
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this AutocompletePlacesRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.places.v1.AutocompletePlacesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AutocompletePlacesRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AutocompletePlacesRequest
AutocompletePlacesRequest |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an AutocompletePlacesRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|