D2lvalenceElixir.Auth.D2LAppContext.create_user_context
You're seeing just the function
create_user_context
, go back to D2lvalenceElixir.Auth.D2LAppContext module for more information.
Specs
create_user_context( %D2lvalenceElixir.Auth.D2LAppContext{app_id: term(), app_key: term()}, [ result_uri: String.t(), host: String.t(), encrypt_requests: true | false, 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() }}
Build a new authentication LMS-user context for a Valence Learning Framework API client application.
:param result_uri:
Entire result URI, including quoted parameters, that the back-end
service redirected the user to after user-authentication.
:param host:
Host/port string for the back-end service
(i.e. `lms.someUni.edu:443`).
:param encrypt_requests:
If true, use HTTPS for requests made through the resulting built
user context; if false (the default), use HTTP.
:param d2l_user_context_props_dict:
If the client application already has access to the properties
dictionary saved from a previous user context, it can provide it
with this property. If this paramter is not `None`, this builder
function ignores the `result_uri` parameter as not
needed.