Gjsify LogoGjsify Logo

Opaque structure, which represents an alarm occurrence, i.e. a instance instance. Use the functions below to work with it.

record

Hierarchy

  • ComponentAlarmInstance

Index

Constructors

  • new ComponentAlarmInstance(uid: string, instanceTime: number, occurStart: number, occurEnd: number): ComponentAlarmInstance
  • Creates a new #ECalComponentAlarmInstance structure, filled with the given values. Free the instance with e_cal_component_alarm_instance_free(), when no longer needed.

    Parameters

    • uid: string

      UID of the alarm

    • instanceTime: number

      instance time, i.e. "5 minutes before the appointment"

    • occurStart: number

      actual event occurrence start to which this instance corresponds

    • occurEnd: number

      actual event occurrence end to which this instance corresponds

    Returns ComponentAlarmInstance

Properties

name: string

Methods

  • getOccurEnd(): number
  • getOccurStart(): number
  • getRid(): string
  • getTime(): number
  • getUid(): string
  • setOccurEnd(occurEnd: number): void
  • Set the actual event occurrence end to which this instance corresponds.

    Parameters

    • occurEnd: number

      event occurence end to set

    Returns void

  • setOccurStart(occurStart: number): void
  • Set the actual event occurrence start to which this instance corresponds.

    Parameters

    • occurStart: number

      event occurence start to set

    Returns void

  • setRid(rid: string): void
  • Set the Recurrence ID of the component this instance was generated for.

    Parameters

    • rid: string

      recurrence UID to set, or %NULL

    Returns void

  • setTime(instanceTime: number): void
  • Set the instance time, i.e. "5 minutes before the appointment".

    Parameters

    • instanceTime: number

      instance time to set

    Returns void

  • setUid(uid: string): void
  • Set the alarm UID.

    Parameters

    • uid: string

      alarm UID to set

    Returns void

  • Creates a new #ECalComponentAlarmInstance structure, filled with the given values. Free the instance with e_cal_component_alarm_instance_free(), when no longer needed.

    Parameters

    • uid: string

      UID of the alarm

    • instanceTime: number

      instance time, i.e. "5 minutes before the appointment"

    • occurStart: number

      actual event occurrence start to which this instance corresponds

    • occurEnd: number

      actual event occurrence end to which this instance corresponds

    Returns ComponentAlarmInstance

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