vx_req_account_login
Reference the Vivox Core SDK API.
Read time 4 minutesLast updated a day ago
Module: Logging In and Logging Out More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | connector_handle The handle returned from a successful [vx_req_connector_create] request. |
| char * | acct_name The user's account name. |
| char * | acct_password The user's account password. |
| vx_session_answer_mode | answer_mode Control how the SDK responds to incoming voice calls. |
| vx_text_mode | enable_text Determine whether the user will enable text for all sessions. |
| int | participant_property_frequency An integer that specifies the maximum number of participant property events the SDK sends while in a channel. |
| int | enable_buddies_and_presence An integer that determines whether to enable and allow buddy and presence information. |
| vx_buddy_management_mode | buddy_management_mode Determine how the SDK handles incoming buddy subscriptions. |
| int | enable_client_ringback |
| int | autopost_crash_dumps If this is set to 1, then the SDK posts crash dumps that occur on SDK threads to Vivox so they can be automatically analyzed. |
| char * | acct_mgmt_server Override the account management server set in [vx_req_connector_create]. |
| char * | application_token An application token that is provided by the developer. |
| char * | application_override A unique string value that identifies the application that is integrated with the SDK. |
| char * | client_ip_override The actual client IP address to pass in requests to the Vivox network. |
| int | enable_presence_persistence Determine whether to enable presence persistence. |
| char * | account_handle The preferred account handle. |
Detailed Description
See: vx_resp_account_login Note: This can only be called after connector initialization has successfully completed.struct vx_req_account_login;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable connector_handle
The handle returned from a successful [vx_req_connector_create] request.VX_HANDLE connector_handle;
variable acct_name
The user's account name.char * acct_name;
variable acct_password
The user's account password.char * acct_password;
variable answer_mode
Control how the SDK responds to incoming voice calls.vx_session_answer_mode answer_mode;
- mode_verify_answer - the default setting.
- mode_auto_answer - this setting is deprecated and should not be used.
- mode_busy_answer - automatically answer every call with a 486 busy.
variable enable_text
Determine whether the user will enable text for all sessions.vx_text_mode enable_text;
- text_mode_enabled - text will be enabled.
- text_mode_disabled - text will not be enabled. The default value is text_mode_enabled.
variable participant_property_frequency
An integer that specifies the maximum number of participant property events the SDK sends while in a channel. If this is set, then the SDK attempts to generate an event at the given frequency, but does not generate two identical events in a row. If this is not set, then the default is "on state change", which means that events are sent when the participant starts talking, stops talking, is muted, or is unmuted. The following list details valid values for this integer:int participant_property_frequency;
- 0 - Never
- 5 - 10 times per second
- 10 - 5 times per second
- 50 - 1 time per second
- 100 - On participant state change (this is the default value)
variable enable_buddies_and_presence
An integer that determines whether to enable and allow buddy and presence information. If this is set to 0 (the default value), then buddy lists and presence status are not retrieved by the SDK, and any command relating to buddies or presence that is submitted to the SDK is rejected. Setting this to 1 enables buddy and presence functionality.int enable_buddies_and_presence;
variable buddy_management_mode
Determine how the SDK handles incoming buddy subscriptions. The following list details valid values:vx_buddy_management_mode buddy_management_mode;
- 0 - mode_auto_accept
- 1 - mode_auto_add
- 2 - mode_block
- 3 - mode_hide
- 4 - mode_application
variable enable_client_ringback
Deprecated: This flag does not affect anything.int enable_client_ringback;
variable autopost_crash_dumps
If this is set to 1, then the SDK posts crash dumps that occur on SDK threads to Vivox so they can be automatically analyzed.int autopost_crash_dumps;
variable acct_mgmt_server
Override the account management server set in [vx_req_connector_create]. If this is set to NULL or empty, the account management server is set to what is used in the vx_req_connector_create command.char * acct_mgmt_server;
variable application_token
An application token that is provided by the developer. Note: This is required if the acct_mgmt_server is configured to require app tokens. This ensures that one application cannot use the resources of another application when sharing the same backend.char * application_token;
variable application_override
A unique string value that identifies the application that is integrated with the SDK. Note: This is an optional value that is provided by Vivox. If this is set, then this overrides the corresponding value in connector create. Any value passed in on this field is present on events received by others that pertain to your identity:char * application_override;
- vx_evt_message_t
- vx_evt_subscription_t
- vx_evt_buddy_presence_t
- vx_evt_session_added_t
variable client_ip_override
The actual client IP address to pass in requests to the Vivox network. Note: This is only supported in the server SDK, and is otherwise ignored.char * client_ip_override;
variable enable_presence_persistence
Determine whether to enable presence persistence.int enable_presence_persistence;
- When this is set to 1, the buddy and watchers list is downloaded from the Vivox backend.
- When this is set to 0, the application is responsible for setting buddies and watchers by using the appropriate requests. The default value is 1.
variable account_handle
The preferred account handle. Attention: This cannot match any existing handle (for example, account_handle or session_handle). This is a string. This must include at least one non-numeric character. If this is empty, then a handle is automatically generated.char * account_handle;