Class: WebexXmlApi::Meeting::CreateMeeting

Inherits:
Object
  • Object
show all
Includes:
Common
Defined in:
lib/webex_xml_api/meeting/create_meeting.rb

Constant Summary collapse

REQUEST_TYPE =
'java:com.webex.service.binding.meeting.CreateMeeting'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Common

#check_response_and_return_data, #create_xml_request, #post_webex_request, #process_object

Constructor Details

#initialize(attributes = {}) ⇒ CreateMeeting

Returns a new instance of CreateMeeting.



12
13
14
15
16
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 12

def initialize(attributes = {})
  @security_context ||= WebexXmlApi::SecurityContext.new(attributes)
  @meeting ||= []
  init_meeting_object
end

Instance Attribute Details

#meetingObject

Returns the value of attribute meeting.



9
10
11
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 9

def meeting
  @meeting
end

#requestObject (readonly)

Returns the value of attribute request.



10
11
12
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 10

def request
  @request
end

#responseObject (readonly)

Returns the value of attribute response.



10
11
12
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 10

def response
  @response
end

#security_contextObject

Returns the value of attribute security_context.



9
10
11
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 9

def security_context
  @security_context
end

Instance Method Details

#agendaObject



45
46
47
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 45

def agenda
  @meeting['metaData']['agenda']
end

#agenda=(str) ⇒ Object



49
50
51
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 49

def agenda=(str)
  @meeting['metaData']['agenda'] = str
end

#conf_nameObject

various getters and setter from here



37
38
39
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 37

def conf_name
  @meeting['metaData']['confName']
end

#conf_name=(str) ⇒ Object



41
42
43
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 41

def conf_name=(str)
  @meeting['metaData']['confName'] = str
end

#durationObject



73
74
75
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 73

def duration
  @meeting['schedule']['duration']
end

#duration=(str) ⇒ Object



77
78
79
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 77

def duration=(str)
  @meeting['schedule']['duration'] = str
end

#enable_audio_videoObject



147
148
149
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 147

def enable_audio_video
  @meeting['enableOptions']['audioVideo']
end

#enable_audio_video=(str) ⇒ Object



151
152
153
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 151

def enable_audio_video=(str)
  @meeting['enableOptions']['audioVideo'] = str
end

#enable_chatObject

rubocop:enable PredicateName



139
140
141
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 139

def enable_chat
  @meeting['enableOptions']['chat']
end

#enable_chat=(str) ⇒ Object



143
144
145
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 143

def enable_chat=(str)
  @meeting['enableOptions']['chat'] = str
end

#first_attendee_as_presenterObject



97
98
99
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 97

def first_attendee_as_presenter
  @meeting['schedule']['firstAttendeeAsPresenter']
end

#first_attendee_as_presenter=(str) ⇒ Object



101
102
103
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 101

def first_attendee_as_presenter=(str)
  @meeting['schedule']['firstAttendeeAsPresenter'] = str
end

#intl_local_call_inObject



113
114
115
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 113

def intl_local_call_in
  @meeting['telephony']['intlLocalCallIn']
end

#intl_local_call_in=(str) ⇒ Object



117
118
119
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 117

def intl_local_call_in=(str)
  @meeting['telephony']['intlLocalCallIn'] = str
end

#is_mp_audioObject

rubocop:disable PredicateName



130
131
132
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 130

def is_mp_audio
  @meeting['telephony']['isMPAudio']
end

#is_mp_audio=(str) ⇒ Object



134
135
136
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 134

def is_mp_audio=(str)
  @meeting['telephony']['isMPAudio'] = str
end

#join_teleconf_before_hostObject



89
90
91
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 89

def join_teleconf_before_host
  @meeting['schedule']['joinTeleconfBeforeHost']
end

#join_teleconf_before_host=(str) ⇒ Object



93
94
95
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 93

def join_teleconf_before_host=(str)
  @meeting['schedule']['joinTeleconfBeforeHost'] = str
end

#meeting_passwordObject



53
54
55
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 53

def meeting_password
  @meeting['accessControl']['meetingPassword']
end

#meeting_password=(str) ⇒ Object



57
58
59
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 57

def meeting_password=(str)
  @meeting['accessControl']['meetingPassword'] = str
end

#open_timeObject



81
82
83
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 81

def open_time
  @meeting['schedule']['openTime']
end

#open_time=(str) ⇒ Object



85
86
87
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 85

def open_time=(str)
  @meeting['schedule']['openTime'] = str
end

#send_requestObject



30
31
32
33
34
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 30

def send_request
  @request = to_xml
  @response = post_webex_request(security_context.site_name, @request)
  check_response_and_return_data(@response)
end

#start_dateObject



61
62
63
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 61

def start_date
  @meeting['schedule']['startDate']
end

#start_date=(str) ⇒ Object



65
66
67
68
69
70
71
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 65

def start_date=(str)
  if str.is_a? String
    @meeting['schedule']['startDate'] = str
  elsif str.is_a? DateTime
    @meeting['schedule']['startDate'] = str.strftime('%m/%d/%Y %H:%M:%S')
  end
end

#teleconf_locationObject



121
122
123
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 121

def teleconf_location
  @meeting['telephony']['teleconfLocation']
end

#teleconf_location=(str) ⇒ Object



125
126
127
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 125

def teleconf_location=(str)
  @meeting['telephony']['teleconfLocation'] = str
end

#telephony_supportObject



105
106
107
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 105

def telephony_support
  @meeting['telephony']['telephonySupport']
end

#telephony_support=(str) ⇒ Object



109
110
111
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 109

def telephony_support=(str)
  @meeting['telephony']['telephonySupport'] = str
end

#to_xmlObject



18
19
20
21
22
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 18

def to_xml
  raise WebexXmlApi::NotEnoughArguments,
        'Meeting::CreateMeeting' unless valid?
  create_xml_request(@security_context.to_xml, REQUEST_TYPE, @meeting)
end

#valid?(context = self) ⇒ Boolean

Returns:

  • (Boolean)


24
25
26
27
28
# File 'lib/webex_xml_api/meeting/create_meeting.rb', line 24

def valid?(context = self)
  return false if context.conf_name.nil?
  return false if context.start_date.nil? || context.duration.nil?
  true
end