OpenXchangeClient.Api.Clientonboarding (open_xchange_client v0.10.0)

API calls for all endpoints tagged Clientonboarding.

Link to this section Summary

Functions

Direct-downloads a profile to configure an apple device for CalDAV and/or CardDAV

Performs a certain client on-boarding action for a given device and scenario; e.g. download a profile or send an E-Mail/SMS

Generate link to direct-download a profile to configure an apple device for CalDAV and/or CardDAV

Retrieves the configuration providing available client on-boarding possibilities for session-associated user

Link to this section Functions

Link to this function

download_client_onboarding_profile(connection, session, type, opts \\ [])

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

Direct-downloads a profile to configure an apple device for CalDAV and/or CardDAV

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • type (String.t): The identifier of profile to download; one of - caldav - carddav - dav
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

execute_client_onboarding(connection, session, id, action_id, opts \\ [])

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

Performs a certain client on-boarding action for a given device and scenario; e.g. download a profile or send an E-Mail/SMS

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • id (String.t): The compiste identifier of device and scenario pair; e.g. "apple.iphone/davsync"
  • action_id (String.t): The identifier of action to perform; one of - download - email - sms - display or - link
  • opts (KeywordList): [optional] Optional parameters
    • :body (String.t): An optional JSON object containing additional data for the action.

returns

Returns

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

Link to this function

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

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

Retrieves the configuration providing available client on-boarding possibilities for session-associated user

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