Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_channel_kick_user

Learn how to remove users from a channel.
Read time 1 minuteLast updated 20 hours ago

Kick a user out of a channel and automatically allow the user back in after 60 seconds. 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 participant URI.
char *access_token
A Vivox Access Token to authorize the operation.

Detailed Description

struct vx_req_channel_kick_user;
Kick a user out of a channel and automatically allow the user back in after 60 seconds. See: vx_resp_channel_kick_user

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 participant URI.

variable access_token

char * access_token;
A Vivox Access Token to authorize the operation.