vx_evt_buddy_presence
Learn about presence and buddy management.
Read time 2 minutesLast updated a day ago
Presented when a buddy has issued presence information.
#include <VxcEvents.h>Public Attributes
Name | |
|---|---|
| vx_evt_base_t | base The common properties for all events. |
| vx_buddy_presence_state | state |
| VX_HANDLE | account_handle The handle returned from a successful login request. |
| char * | buddy_uri The URI of the sender of the message. |
| vx_buddy_presence_state | presence The new presence of the buddy. |
| char * | custom_message A custom message string when presence is set to "custom". |
| char * | displayname The displayname if the buddy_uri had a displayname. |
| char * | application The application of the buddy whose presence is being reported. |
| char * | contact The contact address (URI) of the buddy whose presence is being reported. |
| char * | priority RESERVED FOR FUTURE USE The priority of the buddy whose presence is being reported. |
| char * | id The unique ID of the instance of the buddy whose presence is being reported. |
| char * | encoded_uri_with_tag The unique ID of the instance of the buddy whose presence is being reported. |
Public Attributes Documentation
variable base
The common properties for all events.vx_evt_base_t base;
variable state
Deprecated: This is deprecated and should not be used.vx_buddy_presence_state state;
variable account_handle
The handle returned from a successful login request.VX_HANDLE account_handle;
variable buddy_uri
The URI of the sender of the message.char * buddy_uri;
variable presence
The new presence of the buddy. Refer to the codes in table vx_buddy_presence_statevx_buddy_presence_state presence;
variable custom_message
A custom message string when presence is set to "custom".char * custom_message;
variable displayname
The displayname if the buddy_uri had a displayname.char * displayname;
variable application
The application of the buddy whose presence is being reported. This can be NULL or empty.char * application;
variable contact
The contact address (URI) of the buddy whose presence is being reported. This can be NULL or empty.char * contact;
variable priority
RESERVED FOR FUTURE USE The priority of the buddy whose presence is being reported. This can be NULL or empty.char * priority;
variable id
The unique ID of the instance of the buddy whose presence is being reported. This can be NULL or empty.char * id;
variable encoded_uri_with_tag
The unique ID of the instance of the buddy whose presence is being reported. Note: V5 only. In V4, this is always NULL. This is used to distinguish between the same buddy when they are logged in on different devices. This can be NULL or empty.char * encoded_uri_with_tag;