Gjsify LogoGjsify Logo

Period of time, can have explicit start/end times or start/duration instead. Use the functions below to work with it.

record

Hierarchy

  • ComponentPeriod

Index

Constructors

Properties

name: string

Methods

  • Returns the duration of the period. This can be called only on period objects of kind %E_CAL_COMPONENT_PERIOD_DURATION. The returned #ICalDuration object is owned by period and should not be freed. It's valid until the period is freed or its duration changed.

    Returns Duration

  • Returns the end of the period. This can be called only on period objects of kind %E_CAL_COMPONENT_PERIOD_DATETIME. The end time can be a null-time, in which case the period corresponds to a single date/date-time value, not to a period.

    The returned #ICalTime object is owned by period and should not be freed. It's valid until the period is freed or its end time changed.

    Returns ICalGLib.Time

  • Returns kind of the period, one of #ECalComponentPeriodKind. Depending on it either e_cal_component_period_get_end()/e_cal_component_period_set_end() or e_cal_component_period_get_duration()/e_cal_component_period_set_duration() can be used. The kind of an existing period canbe changed with e_cal_component_period_set_datetime_full() and e_cal_component_period_set_duration_full().

    Returns ComponentPeriodKind

  • Returns the start of the period. The returned #ICalTime object is owned by period and should not be freed. It's valid until the period is freed or its start time changed.

    Returns ICalGLib.Time

  • Set the kind of period to be %E_CAL_COMPONENT_PERIOD_DATETIME and fills the content with start and end.

    Parameters

    Returns void

  • Set the duration of the period. This can be called only on period objects of kind %E_CAL_COMPONENT_PERIOD_DURATION.

    Parameters

    • duration: Duration

      an #ICalDuration, the duration of the period

    Returns void

  • Set the kind of period to be %E_CAL_COMPONENT_PERIOD_DURATION and fills the content with start and duration.

    Parameters

    • start: ICalGLib.Time

      an #ICalTime, the start of the period

    • duration: Duration

      an #ICalDuration, the duration of the period

    Returns void

  • Set the end of the period. This can be called only on period objects of kind %E_CAL_COMPONENT_PERIOD_DATETIME.

    Parameters

    Returns void

  • Creates a new #ECalComponentPeriod of kind %E_CAL_COMPONENT_PERIOD_DATETIME. The returned structure should be freed with e_cal_component_period_free(), when no longer needed.

    Parameters

    Returns ComponentPeriod

  • Creates a new #ECalComponentPeriod of kind %E_CAL_COMPONENT_PERIOD_DURATION. The returned structure should be freed with e_cal_component_period_free(), when no longer needed.

    Parameters

    • start: ICalGLib.Time

      an #ICalTime, the start of the period

    • duration: Duration

      an #ICalDuration, the duration of the period

    Returns ComponentPeriod

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method