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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EntryPoint

Returns a new instance of EntryPoint.



1013
1014
1015
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1013

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) 


923
924
925
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 923

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


930
931
932
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 930

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) 


945
946
947
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 945

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) 


957
958
959
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 957

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) 


967
968
969
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 967

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) 


975
976
977
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 975

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) 


984
985
986
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 984

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) 


993
994
995
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 993

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) 


1000
1001
1002
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1000

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) 


1011
1012
1013
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1011

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1018

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