Excalt v0.1.2

View Source Excalt.Todo (Excalt v0.1.2)

Represents the parsed CalDav reply for todo items.

Link to this section Summary

Types

t()

Functions

create(server_url, username, password, calendar_name, ical_text, uuid)

Creates a new todo item with the given icalendar text.

delete(server_url, username, password, calendar_name, uuid)

Deletes a todo item with the given uuid.

list!(server_url, username, password, calendar_name)

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

list_raw(server_url, username, password, calendar_name)

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

parsed_list!(server_url, username, password, calendar_name)

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

update(server_url, username, password, calendar_name, uuid, ical_text, etag, opts \\ [])

Updates a single todo item, given an uid of the todo, the new version, and the etag. Will throw an error, if the etag has changed in the meantime. (see RFC 4791, section 7.8.1).

Link to this section Types

Link to this type

t()

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

Link to this section Functions

Link to this function

create(server_url, username, password, calendar_name, ical_text, uuid)

View Source 
@spec create(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.t(),
  ical_text :: String.t(),
  uuid :: String.t()
) :: {:ok, etag :: String.t() | nil} | {:error, any()}

Creates a new todo item with the given icalendar text.

Link to this function

delete(server_url, username, password, calendar_name, uuid)

View Source 
@spec delete(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.t(),
  uuid :: String.t()
) :: {:ok, etag :: String.t() | nil} | {:error, any()}

Deletes a todo item with the given uuid.

Link to this function

list!(server_url, username, password, calendar_name)

View Source 
@spec list!(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.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)

View Source 
@spec list_raw(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.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)

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

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

Link to this function

update(server_url, username, password, calendar_name, uuid, ical_text, etag, opts \\ [])

View Source 
@spec update(
  server_url :: String.t(),
  username :: String.t(),
  password :: String.t(),
  calendar_name :: String.t(),
  uuid :: String.t(),
  ical_text :: String.t(),
  etag :: String.t(),
  opts :: keyword()
) :: {:ok, [t()]} | {:error, any()}

Updates a single todo item, given an uid of the todo, the new version, and the etag. Will throw an error, if the etag has changed in the meantime. (see RFC 4791, section 7.8.1).