Class: Google::Apis::CalendarV3::EntryPoint

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/calendar_v3/classes.rb,
generated/google/apis/calendar_v3/representations.rb,
generated/google/apis/calendar_v3/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EntryPoint

Returns a new instance of EntryPoint.



981
982
983
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 981

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_code ⇒ String

The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of meetingCode, accessCode, passcode, password, pin fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. Corresponds to the JSON property accessCode

Returns:

  • (String) 


891
892
893
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 891

def access_code
  @access_code
end

#entry_point_features ⇒ Array<String>

Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. Corresponds to the JSON property entryPointFeatures

Returns:

  • (Array<String>) 


898
899
900
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 898

def entry_point_features
  @entry_point_features
end

#entry_point_type ⇒ String

The type of the conference entry point. Possible values are:

  • "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
  • "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
  • "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
  • "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. Corresponds to the JSON property entryPointType

Returns:

  • (String) 


913
914
915
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 913

def entry_point_type
  @entry_point_type
end

#label ⇒ String

The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples:

  • for video: meet.google.com/aaa-bbbb-ccc
  • for phone: +1 123 268 2601
  • for sip: 12345678@altostrat.com
  • for more: should not be filled Optional. Corresponds to the JSON property label

Returns:

  • (String) 


925
926
927
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 925

def label
  @label
end

#meeting_code ⇒ String

The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of meetingCode, accessCode, passcode, password, pin fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. Corresponds to the JSON property meetingCode

Returns:

  • (String) 


935
936
937
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 935

def meeting_code
  @meeting_code
end

#passcode ⇒ String

The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of meetingCode, accessCode, passcode, password, pin fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Corresponds to the JSON property passcode

Returns:

  • (String) 


943
944
945
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 943

def passcode
  @passcode
end

#password ⇒ String

The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of meetingCode, accessCode, passcode, password, pin fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. Corresponds to the JSON property password

Returns:

  • (String) 


952
953
954
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 952

def password
  @password
end

#pin ⇒ String

The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of meetingCode, accessCode, passcode, password, pin fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. Corresponds to the JSON property pin

Returns:

  • (String) 


961
962
963
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 961

def pin
  @pin
end

#region_code ⇒ String

The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE. Corresponds to the JSON property regionCode

Returns:

  • (String) 


968
969
970
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 968

def region_code
  @region_code
end

#uri ⇒ String

The URI of the entry point. The maximum length is 1300 characters. Format:

  • for video, http: or https: schema is required.
  • for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
  • for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
  • for more, http: or https: schema is required. Corresponds to the JSON property uri

Returns:

  • (String) 


979
980
981
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 979

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 986

def update!(**args)
  @access_code = args[:access_code] if args.key?(:access_code)
  @entry_point_features = args[:entry_point_features] if args.key?(:entry_point_features)
  @entry_point_type = args[:entry_point_type] if args.key?(:entry_point_type)
  @label = args[:label] if args.key?(:label)
  @meeting_code = args[:meeting_code] if args.key?(:meeting_code)
  @passcode = args[:passcode] if args.key?(:passcode)
  @password = args[:password] if args.key?(:password)
  @pin = args[:pin] if args.key?(:pin)
  @region_code = args[:region_code] if args.key?(:region_code)
  @uri = args[:uri] if args.key?(:uri)
end