Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_account_buddy_set

Learn how to set presence information.
Read time 1 minuteLast updated 20 hours ago

Add a buddy to a buddy list or update the properties of a buddy. 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 *buddy_uri
The identifier of the buddy to add to the list.
char *display_name
A readable name for display only.
char *buddy_data
A place to store extra data about a buddy.
intgroup_id
The ID of the group to add the buddy to.
char *message

Detailed Description

struct vx_req_account_buddy_set;
Add a buddy to a buddy list or update the properties of a buddy. See: The buddy is added to the account implied by the account_handle provided in the call. All relevant data about a buddy must be supplied when updating the buddy. If a display name is not specified when updating a the data field, the display name will be blank.

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 buddy_uri

char * buddy_uri;
The identifier of the buddy to add to the list.

variable display_name

char * display_name;
A readable name for display only. Note: This is not required.

variable buddy_data

char * buddy_data;
A place to store extra data about a buddy. Note: This is not required.

variable group_id

int group_id;
The ID of the group to add the buddy to. To remove the buddy from a group, set this to 0.

variable message

char * message;
Note: This is optional. This is limited to a maximum of 256 characters. Attention: This is not currently implemented. A personalized message that the user sees if they receive a vx_evt_subscription_t event.