Class AuthEmailService

Inheritance Relationships

Base Type

Class Documentation

class AuthEmailService : public axr::sdk::ServiceBase<AuthToken>

Public Functions

inline AuthEmailService(std::shared_ptr<Configuration> config, std::shared_ptr<net::IApiClient> apiClient)
inline ~AuthEmailService()
pplx::task<std::shared_ptr<AuthToken>> Authenticate(const utility::char_t *email, const utility::char_t *code)

Retrieves an authorization token using a given email and totp code.

Parameters
  • email – The unique email of the user to authenticate with.

  • code – The time-based one-time password code sent to the user’s e-mail.

Returns

A task whose result is the authentication token.

pplx::task<std::shared_ptr<AuthToken>> Authenticate(const utility::string_t &email, const utility::string_t &code)

Retrieves an authorization token using a given email and totp code.

Parameters
  • email – The unique name of the user to authenticate with.

  • code – The time-based one-time password code sent to the user’s e-mail.

Returns

A task whose result is the authentication token.

pplx::task<void> SendCode(const utility::char_t *email)

Requests a time-based one-time password code to be sent to the e-mail address associated with a registered user.

Parameters

email – The unique email of the user to send a TOTP code to.

Returns

A task whose result is the authentication token.

pplx::task<void> SendCode(const utility::string_t &email)

Requests a time-based one-time password code to be sent to the e-mail address associated with a registered user.

Parameters

email – The unique email of the user to send a TOTP code to.

Returns

A task whose result is the authentication token.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.