vx_req_account_anonymous_login
Reference the Vivox Core SDK API.
Read time 5 minutesLast updated a day ago
Module: Logging In and Logging Out Log in anonymously to the Vivox network. 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 * | displayname The user's display name. |
| 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 RESERVED FOR FUTURE USE Determine whether to enable and allow buddy and presence information. |
| vx_buddy_management_mode | buddy_management_mode RESERVED FOR FUTURE USE Determine how the SDK handles incoming buddy subscriptions. |
| 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 When set to 1, the buddy and watchers list is downloaded from the Vivox backend. |
| char * | account_handle The preferred account handle. |
| char * | acct_name The username portion of the participant URI. |
| char * | access_token A Vivox Access Token to authorize the operation. |
| char ** | initial_buddy_uris An initial list of buddy URIs. |
| char ** | initial_blocked_uris An initial list of blocked URIs. |
| char ** | initial_blocked_uris_presence_only An initial list of blocked URIs for presence only. |
| char ** | initial_allowed_uris An initial list of allowed URIs. |
| char * | languages A comma-separated list of languages that the user prefers. |
Detailed Description
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.struct vx_req_account_anonymous_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 displayname
The user's display name. This is the display name that is seen by others. The length of displayName is limited to a maximum of 127 bytes, plus a null terminator.char * displayname;
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)
variable enable_buddies_and_presence
RESERVED FOR FUTURE USE Determine 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 submitted to the SDK is rejected. Setting this to 1 enables buddy and presence functionality.int enable_buddies_and_presence;
variable buddy_management_mode
RESERVED FOR FUTURE USE Determine how the SDK handles incoming buddy subscriptions.vx_buddy_management_mode buddy_management_mode;
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, then the account management server 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, this overrides the corresponding value in connector create. Any value that is 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
When set to 1, the buddy and watchers list is downloaded from the Vivox backend. When set to 0, the application is responsible for setting buddies and watchers by using the appropriate requests. The default value is 1.int enable_presence_persistence;
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;
variable acct_name
The username portion of the participant URI. acct_name has the following restrictions:char * acct_name;
- The name must start and end with a period (.)
- Only alpha-numeric and the following characters are allowed: = + - _ . ! ~ ( )
- The length of acct_name is limited to a maximum of 127 bytes, plus a null terminator.
variable access_token
A Vivox Access Token to authorize the operation.char * access_token;
variable initial_buddy_uris
An initial list of buddy URIs. Note: V5 only. In V4, this is always equal to NULL. This must be allocated by using vx_allocate(). This can be NULL. If this is non-null, then the last item must be NULL.char ** initial_buddy_uris;
variable initial_blocked_uris
An initial list of blocked URIs. Note: V5 only. In V4, this is always equal to NULL. This must be allocated by using vx_allocate(). This can be NULL. If this is non-null, then the last item must be NULL.char ** initial_blocked_uris;
variable initial_blocked_uris_presence_only
An initial list of blocked URIs for presence only. Note: V5 only. In V4, this always equal to NULL. This must be allocated by using vx_allocate(). This can be NULL. If this is non-null, then the last item must be NULL.char ** initial_blocked_uris_presence_only;
variable initial_allowed_uris
An initial list of allowed URIs. Note: V5 only. In V4, this is always equal to NULL. This must be allocated by using vx_allocate(). This can be NULL. If this is non-null, then the last item must be NULL.char ** initial_allowed_uris;
variable languages
A comma-separated list of languages that the user prefers. Note: This is optional. Attention: Adding a list of languages might impact speech-to-text output for some users. You can specify up to three languages in order of preference. The default is NULL, which implies "en". Languages are identified by tags specified in BCP-47. Example inputs: "en", "en,zh"char * languages;