Period

class Period(**properties: Any)

Superclasses: Object, Object

This is the ICalPeriod instance.

Constructors

class Period

classmethod new_from_string(str: str) → Period

Creates a Period from a string.

Added in version 1.0.

Parameters:

str – The string used to create the Period

classmethod new_null_period() → Period

Creates a default Period.

Added in version 1.0.

Methods

class Period

as_ical_string() → str

Translates Period to string.

Added in version 1.0.

get_duration() → Duration

Gets the duration from an Period.

Added in version 1.0.

get_end() → Time

Gets the end time from an Period.

Added in version 1.0.

get_start() → Time

Gets the start time from an Period.

Added in version 1.0.

is_null_period() → bool

Checks the Period is null_period.

Added in version 1.0.

is_valid_period() → bool

Checks the Period is valid_period.

Added in version 1.0.

set_duration(duration: Duration) → None

Sets the duration of an Period.

Added in version 1.0.

Parameters:

duration – The duration of period

set_end(end: Time) → None

Sets the end time of an Period.

Added in version 1.0.

Parameters:

end – The end of period

set_start(start: Time) → None

Sets the start time of an Period.

Added in version 1.0.

Parameters:

start – The start of period