am_auth_get_status()

Retrieves the state of the authentication process.

Syntax

#include "am_auth.h"
AM_EXPORT am_auth_status_t
am_auth_get_status(am_auth_context_t auth_ctx);

Parameters

This function takes the following parameter:

auth_ctx

The am_auth_context_t type.

---

Note –

See am_auth_context_t for information.

---

Returns

This function returns one of the following values of the am_auth_status_t enumeration as defined:

typedef enum am_auth_status {
    AM_AUTH_STATUS_SUCCESS = 0,
    AM_AUTH_STATUS_FAILED,
    AM_AUTH_STATUS_NOT_STARTED,
    AM_AUTH_STATUS_IN_PROGRESS,
    AM_AUTH_STATUS_COMPLETED
} am_auth_status_t;

AM_AUTH_STATUS_FAILED

The login process has failed.

AM_AUTH_STATUS_NOT_STARTED

The login process has not started.

AM_AUTH_STATUS_IN_PROGRESS

The login is in progress.

AM_AUTH_STATUS_COMPLETED

The user has been logged out.

AM_AUTH_STATUS_SUCCESS

The user has logged in.