Gjsify LogoGjsify Logo

An opaque structure containing an #ICalTime describing the date/time value and also its TZID parameter. Use the functions below to work with it.

record

Hierarchy

  • ComponentDateTime

Index

Constructors

  • Creates a new #ECalComponentDateTime instance, which holds the value and tzid. The returned structure should be freed with e_cal_component_datetime_free(), when no longer needed.

    Parameters

    • value: ICalGLib.Time

      an #ICalTime as a value

    • tzid: string

      timezone ID for the value, or %NULL

    Returns ComponentDateTime

Properties

name: string

Methods

  • Creates a new copy of dt. The returned structure should be freed with e_cal_component_datetime_free() when no longer needed.

    Returns ComponentDateTime

  • getTzid(): string
  • Returns the TZID stored with the dt. The string is owned by dt and it's valid until the dt is freed or its TZID overwritten. It never returns an empty string, it returns either set TZID parameter value or %NULL, when none is set.

    Returns string

  • Returns the value stored with the dt. The object is owned by dt and it's valid until the dt is freed or its value overwritten.

    Returns ICalGLib.Time

  • Sets both value and tzid in one call. Use e_cal_component_datetime_set_value() and e_cal_component_datetime_set_tzid() to set them separately.

    Parameters

    • value: ICalGLib.Time

      an #ICalTime as a value

    • tzid: string

      timezone ID for the value, or %NULL

    Returns void

  • setTzid(tzid: string): void
  • Sets the tzid of the dt. Any previously set TZID is freed. An empty string or a %NULL as tzid is treated as none TZID.

    Parameters

    • tzid: string

      the TZID to set, or %NULL

    Returns void

  • Sets the value of the dt. Any previously set value is freed.

    Parameters

    Returns void

  • takeTzid(tzid: string): void
  • Sets the tzid of the dt and assumes ownership of tzid. Any previously set TZID is freed. An empty string or a %NULL as tzid is treated as none TZID.

    Parameters

    • tzid: string

      the TZID to take, or %NULL

    Returns void

  • Sets the value of the dt and assumes ownership of the value. Any previously set value is freed.

    Parameters

    Returns void

  • Creates a new #ECalComponentDateTime instance, which holds the value and tzid. The returned structure should be freed with e_cal_component_datetime_free(), when no longer needed.

    Parameters

    • value: ICalGLib.Time

      an #ICalTime as a value

    • tzid: string

      timezone ID for the value, or %NULL

    Returns ComponentDateTime

  • Creates a new #ECalComponentDateTime instance, which holds the value and tzid. It is similar to e_cal_component_datetime_new(), except this function assumes ownership of the value and tzid. The returned structure should be freed with e_cal_component_datetime_free(), when no longer needed.

    Parameters

    • value: ICalGLib.Time

      an #ICalTime as a value

    • tzid: string

      timezone ID for the value, or %NULL

    Returns ComponentDateTime

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