OpenXchangeClient.Api.Reminder (open_xchange_client v0.10.0)

API calls for all endpoints tagged Reminder.

Link to this section Summary

Functions

Gets a reminder range. Gets all reminders which are scheduled until the specified time (end date).

Link to this section Functions

Link to this function

delete_reminders(connection, session, body, opts \\ [])

Deletes reminders.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body ([OpenXchangeClient.Model.ReminderListElement.t]): A JSON array with JSON objects containing the field id of the reminders to delete.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

get_range(connection, session, opts \\ [])

@spec get_range(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpenXchangeClient.Model.RemindersResponse.t()} | {:error, Tesla.Env.t()}

Gets a reminder range. Gets all reminders which are scheduled until the specified time (end date).

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters
    • :end (integer()): The end date of the reminder range.
    • :modules (String.t): A comma separated list of module ids to retrieve (e.g. "1,4" for tasks and appointments). If the parameter is missing or empty then all modules are retrieved.

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

remind_again(connection, session, id, body, opts \\ [])

Updates the reminder alarm.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • id (integer()): The ID of the reminder whose alarm date shall be changed.
  • body (ReminderUpdateBody): A JSON object containing the field alarm which provides the new reminder date.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure