class Kaltura::KalturaScheduleEventRecurrence

Attributes

by_day[RW]

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.
by_hour[RW]

Comma separated numbers between 0 to 23

by_minute[RW]

Comma separated numbers between 0 to 59

by_month[RW]

Comma separated numbers between 1 to 12

by_month_day[RW]

Comma separated of numbers between -31 to 31, excluding 0.

For example, -10 represents the tenth to the last day of the month.
by_offset[RW]

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.
by_second[RW]

Comma separated numbers between 0 to 59

by_week_number[RW]

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.
by_year_day[RW]

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).
count[RW]
frequency[RW]
interval[RW]
name[RW]
time_zone[RW]

TimeZone String

until[RW]
week_start_day[RW]

Public Instance Methods

count=(val) click to toggle source
# File lib/kaltura_plugins/kaltura_schedule_client_plugin.rb, line 233
def count=(val)
        @count = val.to_i
end
from_xml(xml_element) click to toggle source
Calls superclass method Kaltura::KalturaObjectBase#from_xml
# File lib/kaltura_plugins/kaltura_schedule_client_plugin.rb, line 240
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
interval=(val) click to toggle source
# File lib/kaltura_plugins/kaltura_schedule_client_plugin.rb, line 236
def interval=(val)
        @interval = val.to_i
end
until=(val) click to toggle source
# File lib/kaltura_plugins/kaltura_schedule_client_plugin.rb, line 230
def until=(val)
        @until = val.to_i
end