Class: Kaltura::KalturaScheduleEventRecurrence

Inherits:
KalturaObjectBase show all
Defined in:
lib/kaltura_plugins/kaltura_schedule_client_plugin.rb

Instance Attribute Summary collapse

Attributes inherited from KalturaObjectBase

#object_type, #related_objects

Instance Method Summary collapse

Methods inherited from KalturaObjectBase

#camelcase, #to_b, #to_params

Instance Attribute Details

#by_day ⇒ Object

Comma separated of KalturaScheduleEventRecurrenceDay Each byDay value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of the specific day within the MONTHLY or YEARLY RRULE. For example, within a MONTHLY rule, +1MO (or simply 1MO) represents the first Monday within the month, whereas -1MO represents the last Monday of the month. If an integer modifier is not present, it means all days of this type within the specified frequency. For example, within a MONTHLY rule, MO represents all Mondays within the month.



258
259
260
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 258

def by_day
  @by_day
end

#by_hour ⇒ Object

Comma separated numbers between 0 to 23



251
252
253
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 251

def by_hour
  @by_hour
end

#by_minute ⇒ Object

Comma separated numbers between 0 to 59



249
250
251
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 249

def by_minute
  @by_minute
end

#by_month ⇒ Object

Comma separated numbers between 1 to 12



273
274
275
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 273

def by_month
  @by_month
end

#by_month_day ⇒ Object

Comma separated of numbers between -31 to 31, excluding 0. For example, -10 represents the tenth to the last day of the month.



261
262
263
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 261

def by_month_day
  @by_month_day
end

#by_offset ⇒ Object

Comma separated of numbers between -366 to 366, excluding 0. Corresponds to the nth occurrence within the set of events specified by the rule. It must only be used in conjunction with another byrule part. For example “the last work day of the month” could be represented as: frequency=MONTHLY;byDay=MO,TU,WE,TH,FR;byOffset=-1 Each byOffset value can include a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of the specific occurrence within the set of events specified by the rule.



280
281
282
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 280

def by_offset
  @by_offset
end

#by_second ⇒ Object

Comma separated numbers between 0 to 59



247
248
249
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 247

def by_second
  @by_second
end

#by_week_number ⇒ Object

Comma separated of numbers between -53 to 53, excluding 0. This corresponds to weeks according to week numbering. A week is defined as a seven day period, starting on the day of the week defined to be the week start. Week number one of the calendar year is the first week which contains at least four (4) days in that calendar year. This rule part is only valid for YEARLY frequency. For example, 3 represents the third week of the year.



271
272
273
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 271

def by_week_number
  @by_week_number
end

#by_year_day ⇒ Object

Comma separated of numbers between -366 to 366, excluding 0. For example, -1 represents the last day of the year (December 31st) and -306 represents the 306th to the last day of the year (March 1st).



264
265
266
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 264

def by_year_day
  @by_year_day
end

#count ⇒ Object

Returns the value of attribute count.



244
245
246
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 244

def count
  @count
end

#frequency ⇒ Object

Returns the value of attribute frequency.



240
241
242
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 240

def frequency
  @frequency
end

#interval ⇒ Object

Returns the value of attribute interval.



245
246
247
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 245

def interval
  @interval
end

#name ⇒ Object

Returns the value of attribute name.



239
240
241
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 239

def name
  @name
end

#time_zone ⇒ Object

TimeZone String



243
244
245
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 243

def time_zone
  @time_zone
end

#until ⇒ Object

Returns the value of attribute until.



241
242
243
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 241

def until
  @until
end

#week_start_day ⇒ Object

Returns the value of attribute week_start_day.



281
282
283
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 281

def week_start_day
  @week_start_day
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 293

def from_xml(xml_element)
	super
	if xml_element.elements['name'] != nil
		self.name = xml_element.elements['name'].text
	end
	if xml_element.elements['frequency'] != nil
		self.frequency = xml_element.elements['frequency'].text
	end
	if xml_element.elements['until'] != nil
		self.until = xml_element.elements['until'].text
	end
	if xml_element.elements['timeZone'] != nil
		self.time_zone = xml_element.elements['timeZone'].text
	end
	if xml_element.elements['count'] != nil
		self.count = xml_element.elements['count'].text
	end
	if xml_element.elements['interval'] != nil
		self.interval = xml_element.elements['interval'].text
	end
	if xml_element.elements['bySecond'] != nil
		self.by_second = xml_element.elements['bySecond'].text
	end
	if xml_element.elements['byMinute'] != nil
		self.by_minute = xml_element.elements['byMinute'].text
	end
	if xml_element.elements['byHour'] != nil
		self.by_hour = xml_element.elements['byHour'].text
	end
	if xml_element.elements['byDay'] != nil
		self.by_day = xml_element.elements['byDay'].text
	end
	if xml_element.elements['byMonthDay'] != nil
		self.by_month_day = xml_element.elements['byMonthDay'].text
	end
	if xml_element.elements['byYearDay'] != nil
		self.by_year_day = xml_element.elements['byYearDay'].text
	end
	if xml_element.elements['byWeekNumber'] != nil
		self.by_week_number = xml_element.elements['byWeekNumber'].text
	end
	if xml_element.elements['byMonth'] != nil
		self.by_month = xml_element.elements['byMonth'].text
	end
	if xml_element.elements['byOffset'] != nil
		self.by_offset = xml_element.elements['byOffset'].text
	end
	if xml_element.elements['weekStartDay'] != nil
		self.week_start_day = xml_element.elements['weekStartDay'].text
	end
end