vx_evt_subscription
Reference the Vivox Core SDK API.
Read time 2 minutesLast updated a day ago
Generated when a buddy wants to request presence visibility. More...
#include <VxcEvents.h>Public Attributes
Name | |
|---|---|
| vx_evt_base_t | base The common properties for all events. |
| VX_HANDLE | account_handle The handle returned from a successful login request. |
| char * | buddy_uri The URI of the buddy whose presence is being sent. |
| char * | subscription_handle The identifier of the subscription event. |
| vx_subscription_type | subscription_type subscription_presence is currently the only supported value. |
| char * | displayname The displayname, if the buddy_uri had a displayname. |
| char * | application The application of the buddy whose subscription is being reported. |
| char * | message NOT CURRENTLY IMPLEMENTED An optional message supplied by the initiating user on vx_req_account_buddy_set_t. |
Detailed Description
Generated when a buddy wants to request presence visibility. See: vx_req_account_buddy_set This event is not presented if an auto-accept or auto-block rule matches the requesting buddy_uri. Typically, the application uses this event to prompt a user to explicitly accept or deny the request for presence. Optionally, the application might create and store an auto-accept or auto-block rule based on the user's selection. The application should generate a vx_req_account_send_subscription_reply_t request based on application logic and/or end-user response. The subscription_handle value must be extracted and returned as a parameter to vx_req_account_send_subscription_reply_t.struct vx_evt_subscription;
Public Attributes Documentation
variable base
The common properties for all events.vx_evt_base_t base;
variable account_handle
The handle returned from a successful login request.VX_HANDLE account_handle;
variable buddy_uri
The URI of the buddy whose presence is being sent.char * buddy_uri;
variable subscription_handle
The identifier of the subscription event. Used when forming a reply with vx_req_account_send_subscription_reply_t.char * subscription_handle;
variable subscription_type
subscription_presence is currently the only supported value.vx_subscription_type subscription_type;
variable displayname
The displayname, if the buddy_uri had a displayname.char * displayname;
variable application
The application of the buddy whose subscription is being reported. This can be NULL or empty.char * application;
variable message
NOT CURRENTLY IMPLEMENTED An optional message supplied by the initiating user on vx_req_account_buddy_set_t.char * message;