vx_evt_buddy_presence
Learn about presence and buddy management.
Read time 2 minutesLast updated 8 months 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
vx_evt_base_t base;
The common properties for all events.
variable state
vx_buddy_presence_state state;
Deprecated:
This is deprecated and should not be used.
variable account_handle
VX_HANDLE account_handle;
The handle returned from a successful login request.
variable buddy_uri
char * buddy_uri;
The URI of the sender of the message.
variable presence
vx_buddy_presence_state presence;
The new presence of the buddy.
Refer to the codes in table vx_buddy_presence_state
variable custom_message
char * custom_message;
A custom message string when presence is set to "custom".
variable displayname
char * displayname;
The displayname if the buddy_uri had a displayname.
variable application
char * application;
The application of the buddy whose presence is being reported.
This can be NULL or empty.
variable contact
char * contact;
The contact address (URI) of the buddy whose presence is being reported.
This can be NULL or empty.
variable priority
char * priority;
RESERVED FOR FUTURE USE The priority of the buddy whose presence is being reported.
This can be NULL or empty.
variable id
char * id;
The unique ID of the instance of the buddy whose presence is being reported.
This can be NULL or empty.
variable encoded_uri_with_tag
char * 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.