matrix_sdk v0.1.0 MatrixSDK.Client.Auth View Source

Convenience functions for building authentication types.

Note: an identifier is only used when doing a password login.

Link to this section Summary

Link to this section Types

Specs

dummy() :: %{type: binary()}

Specs

id() :: id_user() | id_thirdparty() | id_phone()

Specs

id_phone() :: %{type: binary(), country: binary(), phone: binary()}

Specs

id_thirdparty() :: %{type: binary(), medium: binary(), address: binary()}

Specs

id_user() :: %{type: binary(), user: binary()}

Specs

password() :: %{type: binary(), identifier: id(), password: binary()}

Specs

recaptcha() :: %{type: binary(), response: binary()}

Specs

t() :: dummy() | token() | password() | recaptcha() | thirdparty()

Specs

thirdparty() :: %{
  type: binary(),
  threepidCreds: [sid: binary(), client_secret: binary()]
}

Specs

token() :: %{type: binary(), token: binary()}

Link to this section Functions

Link to this function

login_3pid(medium, address, password)

View Source

Specs

login_3pid(binary(), binary(), binary()) :: password()

Specs

login_dummy() :: dummy()
Link to this function

login_email_identity(sid, client_secret)

View Source

Specs

login_email_identity(binary(), binary()) :: thirdparty()
Link to this function

login_msisdn(sid, client_secret)

View Source

Specs

login_msisdn(binary(), binary()) :: thirdparty()
Link to this function

login_phone(country, phone, password)

View Source

Specs

login_phone(binary(), binary(), binary()) :: password()
Link to this function

login_recaptcha(response)

View Source

Specs

login_recaptcha(binary()) :: recaptcha()

Specs

login_token(binary()) :: token()
Link to this function

login_user(user, password)

View Source

Specs

login_user(binary(), binary()) :: password()
Link to this function

put_session(map, session_id)

View Source

Specs

put_session(map(), binary()) :: map()