Logging In and Logging Out
Reference the Vivox Core SDK API.
Read time 3 minutesLast updated a day ago
Classes
Name | |
|---|---|
| struct | vx_req_account_login |
| struct | vx_req_account_authtoken_login |
| struct | vx_req_account_anonymous_login Log in anonymously to the Vivox network. |
| struct | vx_req_account_logout Log a user out of the Vivox system. |
| struct | vx_resp_account_login |
| struct | vx_resp_account_authtoken_login |
| struct | vx_resp_account_anonymous_login The response for vx_req_account_anonymous_login. |
| struct | vx_resp_account_logout The response for vx_req_account_logout. |
| struct | vx_evt_account_login_state_change Sent whenever the login state of the particular account has transitioned from one value to another. |
Types
Name | |
|---|---|
| typedef struct vx_req_account_login | vx_req_account_login_t |
| typedef struct vx_req_account_authtoken_login | vx_req_account_authtoken_login_t |
| typedef struct vx_req_account_anonymous_login | vx_req_account_anonymous_login_t Log in anonymously to the Vivox network. |
| typedef struct vx_req_account_logout | vx_req_account_logout_t Log a user out of the Vivox system. |
| typedef struct vx_resp_account_login | vx_resp_account_login_t |
| typedef struct vx_resp_account_authtoken_login | vx_resp_account_authtoken_login_t |
| typedef struct vx_resp_account_anonymous_login | vx_resp_account_anonymous_login_t The response for vx_req_account_anonymous_login. |
| typedef struct vx_resp_account_logout | vx_resp_account_logout_t The response for vx_req_account_logout. |
| typedef struct vx_evt_account_login_state_change | vx_evt_account_login_state_change_t Sent whenever the login state of the particular account has transitioned from one value to another. |
Functions
Name | |
|---|---|
| VIVOXSDK_DLLEXPORT int | vx_req_account_login_create(vx_req_account_login_t ** req) Allocate and initialize a vx_req_account_login object. |
| VIVOXSDK_DLLEXPORT int | vx_req_account_authtoken_login_create(vx_req_account_authtoken_login_t ** req) Allocate and initialize a vx_req_account_authtoken_login object. |
| VIVOXSDK_DLLEXPORT int | vx_req_account_anonymous_login_create(vx_req_account_anonymous_login_t ** req) Allocate and initialize a vx_req_account_anonymous_login object. |
| VIVOXSDK_DLLEXPORT int | vx_req_account_logout_create(vx_req_account_logout_t ** req) Allocate and initialize a vx_req_account_logout object. |
Types Documentation
typedef vx_req_account_login_t
See: vx_resp_account_login Note: This can only be called after connector initialization has successfully completed.typedef struct vx_req_account_login vx_req_account_login_t;
typedef vx_req_account_authtoken_login_t
See: vx_resp_account_authtoken_login Note: This can only be called after connector initialization has successfully completed.typedef struct vx_req_account_authtoken_login vx_req_account_authtoken_login_t;
typedef vx_req_account_anonymous_login_t
Log in anonymously to the Vivox network. See: vx_resp_account_anonymous_login Note: This can only be called after connector initialization has successfully completed. This allows a user to log in and receive a temporary SIP URI and a user-generated display name, if supplied.typedef struct vx_req_account_anonymous_login vx_req_account_anonymous_login_t;
typedef vx_req_account_logout_t
Log a user out of the Vivox system. See: vx_resp_account_logouttypedef struct vx_req_account_logout vx_req_account_logout_t;
typedef vx_resp_account_login_t
See: vx_req_account_logintypedef struct vx_resp_account_login vx_resp_account_login_t;
typedef vx_resp_account_authtoken_login_t
See: vx_req_account_authtoken_logintypedef struct vx_resp_account_authtoken_login vx_resp_account_authtoken_login_t;
typedef vx_resp_account_anonymous_login_t
The response for vx_req_account_anonymous_login. See: vx_req_account_anonymous_logintypedef struct vx_resp_account_anonymous_login vx_resp_account_anonymous_login_t;
typedef vx_resp_account_logout_t
The response for vx_req_account_logout. See: vx_req_account_logouttypedef struct vx_resp_account_logout vx_resp_account_logout_t;
typedef vx_evt_account_login_state_change_t
Sent whenever the login state of the particular account has transitioned from one value to another.typedef struct vx_evt_account_login_state_change vx_evt_account_login_state_change_t;
Functions Documentation
function vx_req_account_login_create
Allocate and initialize a vx_req_account_login object.VIVOXSDK_DLLEXPORT int vx_req_account_login_create( vx_req_account_login_t ** req)
function vx_req_account_authtoken_login_create
Allocate and initialize a vx_req_account_authtoken_login object.VIVOXSDK_DLLEXPORT int vx_req_account_authtoken_login_create( vx_req_account_authtoken_login_t ** req)
function vx_req_account_anonymous_login_create
Allocate and initialize a vx_req_account_anonymous_login object.VIVOXSDK_DLLEXPORT int vx_req_account_anonymous_login_create( vx_req_account_anonymous_login_t ** req)
function vx_req_account_logout_create
Allocate and initialize a vx_req_account_logout object.VIVOXSDK_DLLEXPORT int vx_req_account_logout_create( vx_req_account_logout_t ** req)