Represents a Photo.
Package
@googlemaps/streetview-publishConstructors
(constructor)(properties)
constructor(properties?: google.streetview.publish.v1.IPhoto);
Constructs a new Photo.
Parameter | |
---|---|
Name | Description |
properties |
IPhoto
Properties to set |
Properties
captureTime
public captureTime?: (google.protobuf.ITimestamp|null);
Photo captureTime.
connections
public connections: google.streetview.publish.v1.IConnection[];
Photo connections.
downloadUrl
public downloadUrl: string;
Photo downloadUrl.
mapsPublishStatus
public mapsPublishStatus: (google.streetview.publish.v1.Photo.MapsPublishStatus|keyof typeof google.streetview.publish.v1.Photo.MapsPublishStatus);
Photo mapsPublishStatus.
photoId
public photoId?: (google.streetview.publish.v1.IPhotoId|null);
Photo photoId.
places
public places: google.streetview.publish.v1.IPlace[];
Photo places.
pose
public pose?: (google.streetview.publish.v1.IPose|null);
Photo pose.
shareLink
public shareLink: string;
Photo shareLink.
thumbnailUrl
public thumbnailUrl: string;
Photo thumbnailUrl.
transferStatus
public transferStatus: (google.streetview.publish.v1.Photo.TransferStatus|keyof typeof google.streetview.publish.v1.Photo.TransferStatus);
Photo transferStatus.
uploadReference
public uploadReference?: (google.streetview.publish.v1.IUploadRef|null);
Photo uploadReference.
uploadTime
public uploadTime?: (google.protobuf.ITimestamp|null);
Photo uploadTime.
viewCount
public viewCount: (number|Long|string);
Photo viewCount.
Methods
create(properties)
public static create(properties?: google.streetview.publish.v1.IPhoto): google.streetview.publish.v1.Photo;
Creates a new Photo instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IPhoto
Properties to set |
Returns | |
---|---|
Type | Description |
Photo |
Photo instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.streetview.publish.v1.Photo;
Decodes a Photo 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 |
Photo |
Photo |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.streetview.publish.v1.Photo;
Decodes a Photo message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Photo |
Photo |
encode(message, writer)
public static encode(message: google.streetview.publish.v1.IPhoto, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Photo message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IPhoto
Photo 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.streetview.publish.v1.IPhoto, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Photo message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IPhoto
Photo 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.streetview.publish.v1.Photo;
Creates a Photo 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 |
Photo |
Photo |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Photo
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 Photo to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.streetview.publish.v1.Photo, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Photo message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Photo
Photo |
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 a Photo message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|