Excalt v0.1.1

View Source Excalt.Event (Excalt v0.1.1)

Link to this section Summary

Types

t()

Functions

list!(server_url, username, password, calendar_name, from, to)

Returns the parsed xml of the calendars for a user from the CalDav server.

list_raw(server_url, username, password, calendar_name, from, to)

Fetches the raw xml of the calendars for a user from the CalDav server.

parsed_list!(server_url, username, password, calendar_name, from, to)

Returns the parsed list of events for a period of time, where also the icalendar parts are parsed.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Excalt.Event{etag: String.t(), icalendar: String.t(), url: String.t()}

Link to this section Functions

Link to this function

list!(server_url, username, password, calendar_name, from, to)

View Source 
@spec list!(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.t(),
  from :: DateTime.t(),
  to :: DateTime.t()
) :: [t()]

Returns the parsed xml of the calendars for a user from the CalDav server.

Link to this function

list_raw(server_url, username, password, calendar_name, from, to)

View Source 
@spec list_raw(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.t(),
  from :: DateTime.t(),
  to :: DateTime.t()
) :: {:ok, xml :: String.t()} | {:error, any()}

Fetches the raw xml of the calendars for a user from the CalDav server.

Link to this function

parsed_list!(server_url, username, password, calendar_name, from, to)

View Source 
@spec parsed_list!(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.t(),
  from :: DateTime.t(),
  to :: DateTime.t()
) :: [t()]

Returns the parsed list of events for a period of time, where also the icalendar parts are parsed.