vx_req_account_control_communications
Reference the Vivox Core SDK API.
Read time 1 minuteLast updated a day ago
Module: Group Voice and Text Communications Manage communication between users. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | account_handle The handle returned from a successful vx_req_account_anonymous_login request. |
| vx_control_communications_operation | operation The operation to perform: block, unblock, list, or clear. |
| char * | user_uris The list of linefeed-separated users to block or unblock. |
| vx_mute_scope | scope The scope of the mute command. |
Detailed Description
Manage communication between users. See: vx_resp_account_control_communicationsstruct vx_req_account_control_communications;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable account_handle
The handle returned from a successful vx_req_account_anonymous_login request.VX_HANDLE account_handle;
variable operation
The operation to perform: block, unblock, list, or clear. Note: This is a bi-directional block and should not be used in conjunction with vx_req_session_set_participant_mute_for_me, because the results can be unpredictable.vx_control_communications_operation operation;
variable user_uris
The list of linefeed-separated users to block or unblock. This should be NULL for vx_control_communications_operation_list or vx_control_communciations_operation_clear operations.char * user_uris;
variable scope
The scope of the mute command. The default setting is mute_scope_all. This is only required for mute and unmute operations. For block operations, this is ignored, and instead works as mute_scope_all.vx_mute_scope scope;