Class: Google::Type::PhoneNumber

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/type/phone_number.rb

Overview

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):

Defined Under Namespace

Classes: ShortCode

Instance Attribute Summary collapse

Instance Attribute Details

#e164_number ⇒ ::String 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'proto_docs/google/type/phone_number.rb', line 86

class PhoneNumber
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An object representing a short code, which is a phone number that is
  # typically much shorter than regular phone numbers and can be used to
  # address messages in MMS and SMS systems, as well as for abbreviated dialing
  # (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
  #
  # Short codes are restricted to a region and are not internationally
  # dialable, which means the same short code can exist in different regions,
  # with different usage and pricing, even if those regions share the same
  # country calling code (e.g. US and CA).
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. The BCP-47 region code of the location where calls to this
  #     short code can be made, such as "US" and "BB".
  #
  #     Reference(s):
  #      - http://www.unicode.org/reports/tr35/#unicode_region_subtag
  # @!attribute [rw] number
  #   @return [::String]
  #     Required. The short code digits, without a leading plus ('+') or country
  #     calling code, e.g. "611".
  class ShortCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#extension ⇒ ::String 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'proto_docs/google/type/phone_number.rb', line 86

class PhoneNumber
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An object representing a short code, which is a phone number that is
  # typically much shorter than regular phone numbers and can be used to
  # address messages in MMS and SMS systems, as well as for abbreviated dialing
  # (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
  #
  # Short codes are restricted to a region and are not internationally
  # dialable, which means the same short code can exist in different regions,
  # with different usage and pricing, even if those regions share the same
  # country calling code (e.g. US and CA).
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. The BCP-47 region code of the location where calls to this
  #     short code can be made, such as "US" and "BB".
  #
  #     Reference(s):
  #      - http://www.unicode.org/reports/tr35/#unicode_region_subtag
  # @!attribute [rw] number
  #   @return [::String]
  #     Required. The short code digits, without a leading plus ('+') or country
  #     calling code, e.g. "611".
  class ShortCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#short_code ⇒ ::Google::Type::PhoneNumber::ShortCode 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'proto_docs/google/type/phone_number.rb', line 86

class PhoneNumber
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An object representing a short code, which is a phone number that is
  # typically much shorter than regular phone numbers and can be used to
  # address messages in MMS and SMS systems, as well as for abbreviated dialing
  # (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
  #
  # Short codes are restricted to a region and are not internationally
  # dialable, which means the same short code can exist in different regions,
  # with different usage and pricing, even if those regions share the same
  # country calling code (e.g. US and CA).
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. The BCP-47 region code of the location where calls to this
  #     short code can be made, such as "US" and "BB".
  #
  #     Reference(s):
  #      - http://www.unicode.org/reports/tr35/#unicode_region_subtag
  # @!attribute [rw] number
  #   @return [::String]
  #     Required. The short code digits, without a leading plus ('+') or country
  #     calling code, e.g. "611".
  class ShortCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end