Constructor
new PostalAddress(propertiesopt)
Constructs a new PostalAddress.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.type.IPostalAddress |
<optional> |
Properties to set |
- Implements:
-
- IPostalAddress
Members
addressLines
PostalAddress addressLines.
administrativeArea
PostalAddress administrativeArea.
languageCode
PostalAddress languageCode.
locality
PostalAddress locality.
organization
PostalAddress organization.
postalCode
PostalAddress postalCode.
recipients
PostalAddress recipients.
regionCode
PostalAddress regionCode.
revision
PostalAddress revision.
sortingCode
PostalAddress sortingCode.
sublocality
PostalAddress sublocality.
Methods
toJSON() → {Object.<string, *>}
Converts this PostalAddress to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.type.PostalAddress}
Creates a new PostalAddress instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.type.IPostalAddress |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.type.PostalAddress |
PostalAddress instance |
(static) decode(reader, lengthopt) → {google.type.PostalAddress}
Decodes a PostalAddress message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.type.PostalAddress |
PostalAddress |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.type.PostalAddress}
Decodes a PostalAddress message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.type.PostalAddress |
PostalAddress |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified PostalAddress message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.type.IPostalAddress |
PostalAddress message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified PostalAddress message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.type.IPostalAddress |
PostalAddress message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.type.PostalAddress}
Creates a PostalAddress message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.type.PostalAddress |
PostalAddress |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for PostalAddress
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a PostalAddress message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.type.PostalAddress |
PostalAddress |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a PostalAddress message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|