public static final class PhoneNumber.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder> implements PhoneNumberOrBuilder
An object representing a phone number, suitable as an API wire format.
This representation:
- should not be used for locale-specific formatting of a phone number, such
as "+1 (650) 253-0000 ext. 123"
- is not designed for efficient storage
- may not be suitable for dialing - specialized libraries (see references)
should be used to parse the number for that purpose
To do something meaningful with this number, such as format it for various
use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first.
For instance, in Java this would be:
com.google.type.PhoneNumber wireProto =
com.google.type.PhoneNumber.newBuilder().build();
com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber =
PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ");
if (!wireProto.getExtension().isEmpty()) {
phoneNumber.setExtension(wireProto.getExtension());
}
Reference(s):
- https://github.com/google/libphonenumber
Protobuf type google.type.PhoneNumber| Modifier and Type | Method and Description |
|---|---|
PhoneNumber.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PhoneNumber |
build() |
PhoneNumber |
buildPartial() |
PhoneNumber.Builder |
clear() |
PhoneNumber.Builder |
clearE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
|
PhoneNumber.Builder |
clearExtension()
The phone number's extension.
|
PhoneNumber.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
PhoneNumber.Builder |
clearKind() |
PhoneNumber.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
PhoneNumber.Builder |
clearShortCode()
A short code.
|
PhoneNumber.Builder |
clone() |
PhoneNumber |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
|
com.google.protobuf.ByteString |
getE164NumberBytes()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
|
String |
getExtension()
The phone number's extension.
|
com.google.protobuf.ByteString |
getExtensionBytes()
The phone number's extension.
|
PhoneNumber.KindCase |
getKindCase() |
PhoneNumber.ShortCode |
getShortCode()
A short code.
|
PhoneNumber.ShortCode.Builder |
getShortCodeBuilder()
A short code.
|
PhoneNumber.ShortCodeOrBuilder |
getShortCodeOrBuilder()
A short code.
|
boolean |
hasE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
|
boolean |
hasShortCode()
A short code.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PhoneNumber.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PhoneNumber.Builder |
mergeFrom(com.google.protobuf.Message other) |
PhoneNumber.Builder |
mergeFrom(PhoneNumber other) |
PhoneNumber.Builder |
mergeShortCode(PhoneNumber.ShortCode value)
A short code.
|
PhoneNumber.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
PhoneNumber.Builder |
setE164Number(String value)
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
|
PhoneNumber.Builder |
setE164NumberBytes(com.google.protobuf.ByteString value)
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
|
PhoneNumber.Builder |
setExtension(String value)
The phone number's extension.
|
PhoneNumber.Builder |
setExtensionBytes(com.google.protobuf.ByteString value)
The phone number's extension.
|
PhoneNumber.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PhoneNumber.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
PhoneNumber.Builder |
setShortCode(PhoneNumber.ShortCode.Builder builderForValue)
A short code.
|
PhoneNumber.Builder |
setShortCode(PhoneNumber.ShortCode value)
A short code.
|
PhoneNumber.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PhoneNumber build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PhoneNumber buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PhoneNumber.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhoneNumber.Builder>public PhoneNumber.Builder mergeFrom(PhoneNumber other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public PhoneNumber.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhoneNumber.Builder>IOExceptionpublic PhoneNumber.KindCase getKindCase()
getKindCase in interface PhoneNumberOrBuilderpublic PhoneNumber.Builder clearKind()
public boolean hasE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
string e164_number = 1;hasE164Number in interface PhoneNumberOrBuilderpublic String getE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
string e164_number = 1;getE164Number in interface PhoneNumberOrBuilderpublic com.google.protobuf.ByteString getE164NumberBytes()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
string e164_number = 1;getE164NumberBytes in interface PhoneNumberOrBuilderpublic PhoneNumber.Builder setE164Number(String value)
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
string e164_number = 1;value - The e164Number to set.public PhoneNumber.Builder clearE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
string e164_number = 1;public PhoneNumber.Builder setE164NumberBytes(com.google.protobuf.ByteString value)
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
string e164_number = 1;value - The bytes for e164Number to set.public boolean hasShortCode()
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;hasShortCode in interface PhoneNumberOrBuilderpublic PhoneNumber.ShortCode getShortCode()
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;getShortCode in interface PhoneNumberOrBuilderpublic PhoneNumber.Builder setShortCode(PhoneNumber.ShortCode value)
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;public PhoneNumber.Builder setShortCode(PhoneNumber.ShortCode.Builder builderForValue)
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;public PhoneNumber.Builder mergeShortCode(PhoneNumber.ShortCode value)
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;public PhoneNumber.Builder clearShortCode()
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;public PhoneNumber.ShortCode.Builder getShortCodeBuilder()
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;public PhoneNumber.ShortCodeOrBuilder getShortCodeOrBuilder()
A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
.google.type.PhoneNumber.ShortCode short_code = 2;getShortCodeOrBuilder in interface PhoneNumberOrBuilderpublic String getExtension()
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
string extension = 3;getExtension in interface PhoneNumberOrBuilderpublic com.google.protobuf.ByteString getExtensionBytes()
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
string extension = 3;getExtensionBytes in interface PhoneNumberOrBuilderpublic PhoneNumber.Builder setExtension(String value)
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
string extension = 3;value - The extension to set.public PhoneNumber.Builder clearExtension()
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
string extension = 3;public PhoneNumber.Builder setExtensionBytes(com.google.protobuf.ByteString value)
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
string extension = 3;value - The bytes for extension to set.public final PhoneNumber.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>public final PhoneNumber.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>Copyright © 2022 Google LLC. All rights reserved.