Class: Webex::Meeting::Schedule

Inherits:
Object
  • Object
show all
Includes:
Webex, Webex::Meeting
Defined in:
lib/webex/meeting/schedule.rb

Overview

comment

Constant Summary

Constants included from Webex::Meeting

PATH_URL

Constants included from Webex

CONFIGURATION, VERSION

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Webex::Meeting

#post_url

Methods included from Webex

#env_attributes!, #option_required!

Constructor Details

#initialize(attributes = {}) ⇒ Schedule

Returns a new instance of Schedule.



28
29
30
31
32
# File 'lib/webex/meeting/schedule.rb', line 28

def initialize(attributes = {})
  attributes.each { |k, v| send("#{k}=", v) }
  env_attributes!
  option_required! :back_url
end

Instance Attribute Details

#agendaObject

Returns the value of attribute agenda.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def agenda
  @agenda
end

#always_repeatObject

Returns the value of attribute always_repeat.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def always_repeat
  @always_repeat
end

#app_locationObject

Returns the value of attribute app_location.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def app_location
  @app_location
end

#app_parameterObject

Returns the value of attribute app_parameter.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def app_parameter
  @app_parameter
end

#attendee_featuresObject

Returns the value of attribute attendee_features.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def attendee_features
  @attendee_features
end

#attendee_informationObject

Returns the value of attribute attendee_information.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def attendee_information
  @attendee_information
end

#auto_delete_after_after_endObject

Returns the value of attribute auto_delete_after_after_end.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def auto_delete_after_after_end
  @auto_delete_after_after_end
end

#auto_start_featureObject

Returns the value of attribute auto_start_feature.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def auto_start_feature
  @auto_start_feature
end

#automatically_accept_registrationObject

Returns the value of attribute automatically_accept_registration.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def automatically_accept_registration
  @automatically_accept_registration
end

#back_urlObject

Returns the value of attribute back_url.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def back_url
  @back_url
end

#callout_phone_numberObject

Returns the value of attribute callout_phone_number.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def callout_phone_number
  @callout_phone_number
end

#charge_modeObject

Returns the value of attribute charge_mode.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def charge_mode
  @charge_mode
end

#cityObject

Returns the value of attribute city.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def city
  @city
end

#companyObject

Returns the value of attribute company.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def company
  @company
end

#country_codeObject

Returns the value of attribute country_code.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def country_code
  @country_code
end

#credit_card_expiration_monthObject

Returns the value of attribute credit_card_expiration_month.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def credit_card_expiration_month
  @credit_card_expiration_month
end

#credit_card_expiration_yearObject

Returns the value of attribute credit_card_expiration_year.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def credit_card_expiration_year
  @credit_card_expiration_year
end

#credit_card_numberObject

Returns the value of attribute credit_card_number.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def credit_card_number
  @credit_card_number
end

#credit_card_typeObject

Returns the value of attribute credit_card_type.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def credit_card_type
  @credit_card_type
end

#dateObject

Returns the value of attribute date.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def date
  @date
end

#descriptionObject

Returns the value of attribute description.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def description
  @description
end

#display_messageObject

Returns the value of attribute display_message.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def display_message
  @display_message
end

#document_locationObject

Returns the value of attribute document_location.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def document_location
  @document_location
end

#durationObject

Returns the value of attribute duration.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def duration
  @duration
end

#email_addressObject

Returns the value of attribute email_address.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def email_address
  @email_address
end

#exclude_PWObject

Returns the value of attribute exclude_PW.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def exclude_PW
  @exclude_PW
end

#first_four_digitsObject

Returns the value of attribute first_four_digits.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def first_four_digits
  @first_four_digits
end

#first_nameObject

Returns the value of attribute first_name.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def first_name
  @first_name
end

#future_useObject

Returns the value of attribute future_use.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def future_use
  @future_use
end

#host_web_ex_idObject

Returns the value of attribute host_web_ex_id.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def host_web_ex_id
  @host_web_ex_id
end

#hourObject

Returns the value of attribute hour.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def hour
  @hour
end

#how_many_minutes_before_event_startsObject

Returns the value of attribute how_many_minutes_before_event_starts.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def how_many_minutes_before_event_starts
  @how_many_minutes_before_event_starts
end

#if_attendee_join_before_hostObject

Returns the value of attribute if_attendee_join_before_host.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_attendee_join_before_host
  @if_attendee_join_before_host
end

#if_auto_play_presentationObject

Returns the value of attribute if_auto_play_presentation.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_auto_play_presentation
  @if_auto_play_presentation
end

#if_note_takerObject

Returns the value of attribute if_note_taker.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_note_taker
  @if_note_taker
end

#if_request_attendee_to_check_rich_media_playsObject

Returns the value of attribute if_request_attendee_to_check_rich_media_plays.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_request_attendee_to_check_rich_media_plays
  @if_request_attendee_to_check_rich_media_plays
end

#if_send_a_confirmation_email_to_the_hostObject

Returns the value of attribute if_send_a_confirmation_email_to_the_host.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_send_a_confirmation_email_to_the_host
  @if_send_a_confirmation_email_to_the_host
end

#if_send_reminder_emailObject

Returns the value of attribute if_send_reminder_email.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_send_reminder_email
  @if_send_reminder_email
end

#if_user_hands_on_labObject

Returns the value of attribute if_user_hands_on_lab.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def if_user_hands_on_lab
  @if_user_hands_on_lab
end

#internet_phoneObject

Returns the value of attribute internet_phone.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def internet_phone
  @internet_phone
end

#invitation_emailObject

Returns the value of attribute invitation_email.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def invitation_email
  @invitation_email
end

#lab_nameObject

Returns the value of attribute lab_name.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def lab_name
  @lab_name
end

#last_four_digitsObject

Returns the value of attribute last_four_digits.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def last_four_digits
  @last_four_digits
end

#last_nameObject

Returns the value of attribute last_name.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def last_name
  @last_name
end

#list_flagObject

Returns the value of attribute list_flag.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def list_flag
  @list_flag
end

#maxinum_registrations_allowedObject

Returns the value of attribute maxinum_registrations_allowed.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def maxinum_registrations_allowed
  @maxinum_registrations_allowed
end

#meeting_descriptionObject

Returns the value of attribute meeting_description.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_description
  @meeting_description
end

#meeting_emailObject

Returns the value of attribute meeting_email.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_email
  @meeting_email
end

#meeting_featuresObject

Returns the value of attribute meeting_features.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_features
  @meeting_features
end

#meeting_greetingObject

Returns the value of attribute meeting_greeting.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_greeting
  @meeting_greeting
end

#meeting_nameObject

Returns the value of attribute meeting_name.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_name
  @meeting_name
end

#meeting_passwordObject

Returns the value of attribute meeting_password.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_password
  @meeting_password
end

#meeting_typeObject

Returns the value of attribute meeting_type.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def meeting_type
  @meeting_type
end

#minuteObject

Returns the value of attribute minute.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def minute
  @minute
end

#mobile_device_numberObject

Returns the value of attribute mobile_device_number.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def mobile_device_number
  @mobile_device_number
end

#monthObject

Returns the value of attribute month.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def month
  @month
end

#note_taker_optionObject

Returns the value of attribute note_taker_option.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def note_taker_option
  @note_taker_option
end

#number_of_attendeesObject

Returns the value of attribute number_of_attendees.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def number_of_attendees
  @number_of_attendees
end

#number_of_computersObject

Returns the value of attribute number_of_computers.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def number_of_computers
  @number_of_computers
end

#number_of_presentersObject

Returns the value of attribute number_of_presenters.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def number_of_presenters
  @number_of_presenters
end

#number_of_sessionsObject

Returns the value of attribute number_of_sessions.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def number_of_sessions
  @number_of_sessions
end

#other_teleconferencing_descriptionObject

Returns the value of attribute other_teleconferencing_description.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def other_teleconferencing_description
  @other_teleconferencing_description
end

#password_filter_featureObject

Returns the value of attribute password_filter_feature.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def password_filter_feature
  @password_filter_feature
end

#phone_numberObject

Returns the value of attribute phone_number.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def phone_number
  @phone_number
end

#recurrence_typeObject

Returns the value of attribute recurrence_type.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def recurrence_type
  @recurrence_type
end

#registration_close_dateObject

Returns the value of attribute registration_close_date.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def registration_close_date
  @registration_close_date
end

#registration_close_monthObject

Returns the value of attribute registration_close_month.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def registration_close_month
  @registration_close_month
end

#registration_close_yearObject

Returns the value of attribute registration_close_year.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def registration_close_year
  @registration_close_year
end

#registration_passwordObject

Returns the value of attribute registration_password.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def registration_password
  @registration_password
end

#reminder_emailObject

Returns the value of attribute reminder_email.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def reminder_email
  @reminder_email
end

#repeat_daysObject

Returns the value of attribute repeat_days.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def repeat_days
  @repeat_days
end

#request_loginObject

Returns the value of attribute request_login.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def 
  @request_login
end

#require_attendee_registrationObject

Returns the value of attribute require_attendee_registration.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def require_attendee_registration
  @require_attendee_registration
end

#stateObject

Returns the value of attribute state.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def state
  @state
end

#streetObject

Returns the value of attribute street.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def street
  @street
end

#tele_linesObject

Returns the value of attribute tele_lines.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def tele_lines
  @tele_lines
end

#teleconference_configurationObject

Returns the value of attribute teleconference_configuration.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def teleconference_configuration
  @teleconference_configuration
end

#timeObject

Returns the value of attribute time.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def time
  @time
end

#time_zoneObject

Returns the value of attribute time_zone.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def time_zone
  @time_zone
end

#tracking_codesObject

Returns the value of attribute tracking_codes.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def tracking_codes
  @tracking_codes
end

#tsp_accountObject

Returns the value of attribute tsp_account.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def 
  @tsp_account
end

#until_dayObject

Returns the value of attribute until_day.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def until_day
  @until_day
end

#until_monthObject

Returns the value of attribute until_month.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def until_month
  @until_month
end

#until_yearObject

Returns the value of attribute until_year.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def until_year
  @until_year
end

#urlObject

Returns the value of attribute url.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def url
  @url
end

#whole_informationObject

Returns the value of attribute whole_information.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def whole_information
  @whole_information
end

#windows_app_handleObject

Returns the value of attribute windows_app_handle.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def windows_app_handle
  @windows_app_handle
end

#yearObject

Returns the value of attribute year.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def year
  @year
end

#zip_codeObject

Returns the value of attribute zip_code.



7
8
9
# File 'lib/webex/meeting/schedule.rb', line 7

def zip_code
  @zip_code
end

Instance Method Details

#editObject



34
35
36
37
# File 'lib/webex/meeting/schedule.rb', line 34

def edit
  res = Net::HTTP.post_form post_url, generate_params(api_type: 'EM')
  Hash[res.body.stringify_string.split('&').map! { |i| i.split('=') }]
end

#generate_params(overwrite_params = {}) ⇒ Object



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/webex/meeting/schedule.rb', line 49

def generate_params(overwrite_params = {})
  result = {}
  result[:AT] = overwrite_params[:api_type]
  result[:BU] = back_url
  result[:MN] = meeting_name
  result[:MT] = meeting_type
  result[:LF] = list_flag
  result[:PW] = meeting_password
  result[:PR] = password_filter_feature
  result[:AR] = require_attendee_registration
  result[:AQ] = automatically_accept_registration
  result[:AI] = attendee_information
  result[:RPW] = registration_password # TC
  result[:NR] = maxinum_registrations_allowed # TC
  result[:RCY] = registration_close_year # TC
  result[:RCM] = registration_close_month # TC
  result[:RCD] = registration_close_date # TC
  result[:TC] = teleconference_configuration
  result[:IP] = internet_phone
  result[:TL] = tele_lines
  result[:TD] = other_teleconferencing_description
  result[:ExcludePW] = exclude_PW
  result[:RequestALogin] = 
  result[:TA] =  # MC 6.0
  result[:APP] = if_auto_play_presentation # MC 6.0
  result[:APPD] = document_location # MC 6.0
  result[:AJ] = if_attendee_join_before_host # MC 6.0
  result[:AJMI] = how_many_minutes_before_event_starts # MC 6.0
  result[:NT] = if_note_taker # MC 6.0
  result[:NTOP] = note_taker_option # MC 6.0
  result[:TZ] = time_zone
  result[:DU] = duration
  result[:NA] = number_of_attendees
  result[:NP] = number_of_presenters # TC
  result.merge!(tracking_code_hash) if tracking_codes
  result[:YE] = year
  result[:MO] = month
  result[:DA] = date
  result[:HO] = hour
  result[:MI] = minute
  result[:NS] = number_of_sessions # TC
  result[:UntilYE] = until_year
  result[:UntilMO] = until_month
  result[:UntilDA] = until_day
  result[:TY] = recurrence_type # TC
  result[:RO] = recurrence_type # MC
  result[:Days] = repeat_days
  result[:Always] = always_repeat # MC
  result[:Email] = reminder_email
  result[:ME] = meeting_email # MC
  result[:BM] = if_send_reminder_email # MC
  result[:ReminderTime] = time
  result[:MobileDN] = mobile_device_number # MC
  result[:CM] = charge_mode
  result[:WI] = whole_information
  result[:CT] = credit_card_type
  result[:FN] = first_name
  result[:LN] = last_name # MC
  result[:LA] = last_name # TC
  result[:CN] = credit_card_number
  result[:EM] = credit_card_expiration_month
  result[:EY] = credit_card_expiration_year
  result[:ML] = email_address
  result[:CP] = company
  result[:SR] = street
  result[:CI] = city
  result[:ST] = state
  result[:ZP] = zip_code
  result[:CY] = country_code
  result[:PO] = phone_number
  result[:LU] = future_use
  result[:F4] = first_four_digits
  result[:L4] = last_four_digits
  result[:AG] = agenda
  result[:AF] = attendee_features
  result[:MF] = meeting_features
  result[:DS] = description # TC
  result[:MD] = meeting_description # MC
  result[:PM] = display_message
  result[:MG] = meeting_greeting
  result[:TA] =  # TC
  result[:QK] = if_request_attendee_to_check_rich_media_plays # MC
  result[:CE] = if_send_a_confirmation_email_to_the_host # MC
  result[:AutoDeleteAfterEnd] = auto_delete_after_after_end # MC
  result[:CO] = callout_phone_number
  result[:HI] = host_web_ex_id
  result[:HL] = if_user_hands_on_lab # TC
  result[:LN] = lab_name # TC
  result[:NC] = number_of_computers # TC
  result[:VE] = invitation_email
  if result[:AT] == 'IM'
    result[:AS] = auto_start_feature
    result[:DL] = document_location
    result[:AL] = app_location
    result[:AH] = windows_app_handle
    result[:WL] = url
    result[:AP] = app_parameter
  end
  result.delete_if { |k, v| v.nil? }
end

#impromptuObject



44
45
46
47
# File 'lib/webex/meeting/schedule.rb', line 44

def impromptu
  res = Net::HTTP.post_form post_url, generate_params(api_type: 'IM')
  Hash[res.body.stringify_string.split('&').map! { |i| i.split('=') }]
end

#scheduleObject



39
40
41
42
# File 'lib/webex/meeting/schedule.rb', line 39

def schedule
  res = Net::HTTP.post_form post_url, generate_params(api_type: 'SM')
  Hash[res.body.stringify_string.split('&').map! { |i| i.split('=') }]
end