D2lvalenceElixir.Auth (D2lvalenceElixir v0.1.0) View Source

Provides auth assistance for Desire2Learn's Valence API client applications.

Link to this section Summary

Link to this section Functions

Link to this function

fashion_app_context(options \\ [])

View Source

Specs

fashion_app_context(%{app_id: String.t(), app_key: String.t()} | []) ::
  %D2lvalenceElixir.Auth.D2LAppContext{app_id: binary(), app_key: binary()}

Build a new application context.

:param app_id: D2L-provided Application ID string.

:param app_key: D2L-provided Application Key string, used for signing.

Link to this function

fashion_user_context(options \\ [])

View Source

Specs

fashion_user_context(
  %{app_id: String.t(), app_key: String.t(), d2l_user_context_props_dict: %{}}
  | []
) ::
  {:error, String.t()}
  | {:ok,
     %D2lvalenceElixir.Auth.D2LUserContext{
       anonymous: false | true,
       app_id: String.t(),
       app_key: String.t(),
       encrypt_requests: true | false,
       host: String.t(),
       scheme: String.t(),
       server_skew: String.t(),
       user_id: String.t(),
       user_key: String.t()
     }}