caldav_client

View Source CalDAVClient.XML.Builder (caldav_client v2.0.0)

Builds XML request body for the calendar server.

Link to this section Summary

Functions

build_create_calendar_xml(opts \\ [])

Generates XML request body to create a calendar (see RFC 4791, section 5.3.1.2).

build_retrieval_of_event_by_uid_xml(uid)

Generates XML request body to retrieve event with specified UID property (see RFC 4791, section 7.8.6).

build_retrieval_of_events_having_alarm_xml(from, to, opts \\ [])

Generates XML request body to retrieve all events or its occurrences having an VALARM within a specific time range (see RFC 4791, section 7.8.5).

build_retrieval_of_events_xml(start_datetime, end_datetime, opts \\ [])

Generates XML request body to retrieve all events or its occurrences within a specific time range (see RFC 4791, section 7.8.1).

build_update_calendar_xml(opts \\ [])

Generates XML request body to update calendar properties.

Link to this section Functions

Link to this function

build_create_calendar_xml(opts \\ [])

View Source

Specs

build_create_calendar_xml(opts :: keyword()) :: String.t()

Generates XML request body to create a calendar (see RFC 4791, section 5.3.1.2).

options

 Options

  • name - calendar name.
  • description - calendar description.
Link to this function

build_retrieval_of_event_by_uid_xml(uid)

View Source

Generates XML request body to retrieve event with specified UID property (see RFC 4791, section 7.8.6).

Link to this function

build_retrieval_of_events_having_alarm_xml(from, to, opts \\ [])

View Source

Specs

build_retrieval_of_events_having_alarm_xml(
  from :: DateTime.t(),
  to :: DateTime.t(),
  opts :: keyword()
) :: String.t()

Generates XML request body to retrieve all events or its occurrences having an VALARM within a specific time range (see RFC 4791, section 7.8.5).

Link to this function

build_retrieval_of_events_xml(start_datetime, end_datetime, opts \\ [])

View Source

Specs

build_retrieval_of_events_xml(
  start_icalendar :: DateTime.t(),
  end_icalendar :: DateTime.t(),
  opts :: keyword()
) :: String.t()

Generates XML request body to retrieve all events or its occurrences within a specific time range (see RFC 4791, section 7.8.1).

options

 Options

  • expand - if true, recurring events will be expanded to occurrences, defaults to false.
Link to this function

build_update_calendar_xml(opts \\ [])

View Source

Specs

build_update_calendar_xml(opts :: keyword()) :: String.t()

Generates XML request body to update calendar properties.

options

 Options

  • name - calendar name.
  • description - calendar description.