OpenXchangeClient.Api.Sessionmanagement (open_xchange_client v0.10.1)

API calls for all endpoints tagged Sessionmanagement.

Link to this section Summary

Functions

Get all user's sessions

Removes all user's session expect given and blacklisted

Link to this section Functions

Link to this function

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

Get all user's sessions

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

returns

Returns

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

Link to this function

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

@spec clear(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Removes all user's session expect given and blacklisted

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

returns

Returns

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

Link to this function

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

@spec delete(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Remove user's session

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body ([String.t]): A JSON array containing all session Ids to delete
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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