Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_channel_ban_user

Learn about voice channels in Vivox Core.
Read time 1 minuteLast updated 20 hours ago

More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
VX_HANDLEaccount_handle
The handle returned from a successful vx_req_account_anonymous_login request.
char *channel_name
char *channel_uri
The URI of the channel.
char *participant_uri
The URI of the participant to ban or unban.
intset_banned
Set to 1 to ban the user.

Detailed Description

struct vx_req_channel_ban_user;
See: vx_resp_channel_ban_user Note: This request is only valid if the account that makes the request has moderator privileges on the target channel.

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable account_handle

VX_HANDLE account_handle;
The handle returned from a successful vx_req_account_anonymous_login request.

variable channel_name

char * channel_name;
Deprecated: This field is ignored. The name of the channel.

variable channel_uri

char * channel_uri;
The URI of the channel.

variable participant_uri

char * participant_uri;
The URI of the participant to ban or unban.

variable set_banned

int set_banned;
Set to 1 to ban the user. Set to 0 to unban the user.