OpenXchangeClient.Api.ShareManagement (open_xchange_client v0.10.1)

API calls for all endpoints tagged ShareManagement.

Link to this section Summary

Link to this section Functions

Link to this function

delete_share_link(connection, session, timestamp, body, opts \\ [])

Deletes a share link.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • timestamp (integer()): The timestamp of the last modification of the link. Used to detect concurrent modifications.
  • body (ShareTargetData): A JSON object containing the share target where the link should be deleted for.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

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

Creates or gets a share link.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body (ShareTargetData): A JSON object containing the share target where the link should be generated for.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

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

Sends a share link.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body (ShareLinkSendBody): A JSON object containing the share target and a list of recipients specified in a field recipients that is a JSON array with a nested two-elements array containing the recipient information (first element is personal name, second is email address). An optional field message can contain a notification.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

update_share_link(connection, session, timestamp, body, opts \\ [])

Updates a share link.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • timestamp (integer()): The timestamp of the last modification of the link. Used to detect concurrent modifications.
  • body (ShareLinkUpdateBody): A JSON object containing the share target and share link properties of the link to update. Only modified fields should be set but at least the share target ones.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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