GraphApi.Calendar (GraphApi v1.0.0-rc.1)

Operations on calendar resources (/users/{id}/events, /users/{id}/calendarView, etc.).

Examples

{:ok, %{"value" => events}} = GraphApi.Calendar.list_events("user-id")

{:ok, %{"value" => view}} = GraphApi.Calendar.calendar_view("user-id",
  start_date_time: "2024-01-01T00:00:00",
  end_date_time: "2024-01-31T23:59:59"
)

Summary

Functions

calendar_view(user_id, opts \\ [])

Gets the calendar view (events in a date range) for a user.

calendar_view_query(user_id, opts \\ [])

Batch query variant of calendar_view/2. Embeds start/end datetimes in the URL.

create_event(user_id, attrs, opts \\ [])

Creates an event on a user's default calendar.

create_event_query(user_id, attrs, opts \\ [])

Batch query variant of create_event/3.

delete_event(user_id, event_id, opts \\ [])

Deletes an event.

delete_event_query(user_id, event_id, opts \\ [])

Batch query variant of delete_event/3.

events_delta(user_id, opts \\ [])

Delta query for a user's calendar events. Returns event changes since the last sync.

events_delta_query(user_id, opts \\ [])

Batch query variant of events_delta/2.

get_event(user_id, event_id, opts \\ [])

Gets a specific event.

get_event_query(user_id, event_id, opts \\ [])

Batch query variant of get_event/3.

list_calendars(user_id, opts \\ [])

Lists a user's calendars.

list_calendars_query(user_id, opts \\ [])

Batch query variant of list_calendars/2.

list_events(user_id, opts \\ [])

Lists events on a user's default calendar.

list_events_query(user_id, opts \\ [])

Batch query variant of list_events/2.

update_event(user_id, event_id, attrs, opts \\ [])

Updates an event.

update_event_query(user_id, event_id, attrs, opts \\ [])

Batch query variant of update_event/4.

Functions

calendar_view(user_id, opts \\ [])

@spec calendar_view(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Gets the calendar view (events in a date range) for a user.

Required Options

:start_date_time - ISO 8601 start datetime string
:end_date_time - ISO 8601 end datetime string

Examples

GraphApi.Calendar.calendar_view("user-id",
  start_date_time: "2024-01-01T00:00:00",
  end_date_time: "2024-01-31T23:59:59"
)

calendar_view_query(user_id, opts \\ [])

@spec calendar_view_query(
  String.t(),
  keyword()
) :: GraphApi.Batch.Request.t()

Batch query variant of calendar_view/2. Embeds start/end datetimes in the URL.

create_event(user_id, attrs, opts \\ [])

@spec create_event(String.t(), map(), keyword()) :: {:ok, map()} | {:error, term()}

Creates an event on a user's default calendar.

create_event_query(user_id, attrs, opts \\ [])

@spec create_event_query(String.t(), map(), keyword()) :: GraphApi.Batch.Request.t()

Batch query variant of create_event/3.

delete_event(user_id, event_id, opts \\ [])

@spec delete_event(String.t(), String.t(), keyword()) :: :ok | {:error, term()}

Deletes an event.

delete_event_query(user_id, event_id, opts \\ [])

@spec delete_event_query(String.t(), String.t(), keyword()) ::
  GraphApi.Batch.Request.t()

Batch query variant of delete_event/3.

events_delta(user_id, opts \\ [])

@spec events_delta(
  String.t(),
  keyword()
) :: {:ok, GraphApi.Delta.delta_page()} | {:error, term()}

Delta query for a user's calendar events. Returns event changes since the last sync.

events_delta_query(user_id, opts \\ [])

@spec events_delta_query(
  String.t(),
  keyword()
) :: GraphApi.Batch.Request.t()

Batch query variant of events_delta/2.

get_event(user_id, event_id, opts \\ [])

@spec get_event(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Gets a specific event.

get_event_query(user_id, event_id, opts \\ [])

@spec get_event_query(String.t(), String.t(), keyword()) :: GraphApi.Batch.Request.t()

Batch query variant of get_event/3.

list_calendars(user_id, opts \\ [])

@spec list_calendars(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Lists a user's calendars.

list_calendars_query(user_id, opts \\ [])

@spec list_calendars_query(
  String.t(),
  keyword()
) :: GraphApi.Batch.Request.t()

Batch query variant of list_calendars/2.

list_events(user_id, opts \\ [])

@spec list_events(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Lists events on a user's default calendar.

list_events_query(user_id, opts \\ [])

@spec list_events_query(
  String.t(),
  keyword()
) :: GraphApi.Batch.Request.t()

Batch query variant of list_events/2.

update_event(user_id, event_id, attrs, opts \\ [])

@spec update_event(String.t(), String.t(), map(), keyword()) ::
  {:ok, map()} | :ok | {:error, term()}

Updates an event.

update_event_query(user_id, event_id, attrs, opts \\ [])

@spec update_event_query(String.t(), String.t(), map(), keyword()) ::
  GraphApi.Batch.Request.t()

Batch query variant of update_event/4.