Gjsify LogoGjsify Logo

Opaque structure, which represents when an alarm is supposed to be triggered. Use the functions below to work with it.

record

Hierarchy

  • ComponentAlarmTrigger

Index

Constructors

Properties

name: string

Methods

  • Returns the trigger absolute time for an absolute trigger, or %NULL, when the trigger is a relative trigger. The object is owned by trigger and it's valid until the trigger is freed or its absolute time changed.

    Returns ICalGLib.Time

  • Converts information stored in trigger into an #ICalProperty of %I_CAL_TRIGGER_PROPERTY kind. The caller is responsible to free the returned object with g_object_unref(), when no longer needed.

    Returns ICalGLib.Property

  • Returns the trigger duration for a relative trigger, or %NULL, when the trigger is an absolute trigger.

    Returns Duration

  • Set the trigegr with the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE kind and the absolute_time as the time of the trigger. The absolute_time should be date/time (not date) in UTC.

    To set a relative trigger use e_cal_component_alarm_trigger_set_relative().

    Parameters

    • absoluteTime: ICalGLib.Time

      the absolute time when to trigger the alarm, as an #ICalTime

    Returns void

  • Sets the trigger absolute time for an absolute trigger. The absolute_time should be date/time (not date) in UTC.

    The function does nothing, when the trigger is a relative trigger.

    Parameters

    • absoluteTime: ICalGLib.Time

      absolute time for an absolute trigger, as an #ICalTime

    Returns void

  • Sets the trigger duration for a relative trigger. The function does nothing, when the trigger is an absolute trigger. The object is owned by trigger and it's valid until the trigger is freed or its relative duration changed.

    Parameters

    • duration: Duration

      duration for a relative trigger, as an #ICalDuration

    Returns void

  • Fill the trigger structure with the information from the property, which should be of %I_CAL_TRIGGER_PROPERTY kind.

    Parameters

    Returns void

  • Set the trigger kind to kind. This works only for other than the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE. To change the kind from absolute to relative, or vice versa, use either e_cal_component_alarm_trigger_set_relative() or e_cal_component_alarm_trigger_set_absolute().

    Parameters

    Returns void

  • Set the trigegr with the given kind and duration. The kind can be any but the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE. To set an absolute trigger use e_cal_component_alarm_trigger_set_absolute().

    Parameters

    • kind: ComponentAlarmTriggerKind

      an #ECalComponentAlarmTriggerKind, any but the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE

    • duration: Duration

      the duration relative to kind, as an #ICalDuration

    Returns void

  • Creates a new #ECalComponentAlarmTrigger structure, set with the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE kind and the absolute_time as the time of the trigger. The absolute_time should be date/time (not date) in UTC.

    To create a relative trigger use e_cal_component_alarm_trigger_new_relative(). Free the trigger with e_cal_component_alarm_trigger_free(), when no longer needed.

    Parameters

    • absoluteTime: ICalGLib.Time

      the absolute time when to trigger the alarm, as an #ICalTime

    Returns ComponentAlarmTrigger

  • Creates a new #ECalComponentAlarmTrigger, filled with values from property, which should be of kind %I_CAL_TRIGGER_PROPERTY. The function returns %NULL when it is not of the expected kind. Free the structure with e_cal_component_alarm_trigger_free(), when no longer needed.

    Parameters

    Returns ComponentAlarmTrigger

  • Creates a new #ECalComponentAlarmTrigger structure, set with the given kind and duration. The kind can be any but the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE. To create an absolute trigger use e_cal_component_alarm_trigger_new_absolute(). Free the trigger with e_cal_component_alarm_trigger_free(), when no longer needed.

    Parameters

    • kind: ComponentAlarmTriggerKind

      an #ECalComponentAlarmTriggerKind, any but the %E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE

    • duration: Duration

      the duration relative to kind, as an #ICalDuration

    Returns ComponentAlarmTrigger

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