CProtocol
#include "Protocol.h"
Description
Protocol class.
Private variables
| Type | Name | Description |
|---|---|---|
| PPluginAgent | PluginAgent | Variable used to communicate with AQQ |
Public variables
| Type | Name | Description |
|---|---|---|
| UnicodeString | JID | Protocol domain, eg. "skype.contact" |
| UnicodeString | Name | Name to show in add contact window, eg. "Skype contact" |
| UnicodeString | Prompt | Name to show as label for contact ID edit in add contact window, eg. "Skype login" |
| bool | Transport | Allow to add contacts? |
| bool | Search | Allow to search contacts? |
| bool | GroupChat | Allow to start group chat |
| UnicodeString | Description | Protocol description |
| bool | RequiredID | Protocol can recognize contacts basing on any JID? |
| int | IconID | Protocol icon ID. For example icon is used in "Add contact" window |
| UnicodeString | AccountName | Protocol name, eg. "Skype protocol" |
Public methods
| Type | Name | Description |
|---|---|---|
| CProtocol() | Constructor | |
| ~CProtocol() | Destructor | |
| PPluginAgent | AQQFormat() | Function converts this object to AQQ structure |
| void | SDKFormat(PPluginAgent PluginAgent) | Function converts AQQ structure to this object |
| int | Register() | Function registers a new protocol in AQQ. Return 0 on success |
| int | Update() | Function updates exiting protocol. Returns 1 on success or 0 if protocol does not exists and it's created |
| bool | Remove() | Function removes protocol from AQQ. Returns 0 in case of error else returns 1 |
Example
Example plugin that creates a new protocol you may find here.