libtransport.git Changeset - 48c2ae07de16

Changeset - 48c2ae07de16

Parent rev.

Child rev.

[Not reviewed]

0 1 0

Jan Kaluza - 14 years ago 2011-08-23 14:34:57
hanzz.k@gmail.com

More docs

1 file changed with 36 insertions and 1 deletions:

include/transport/networkplugin.h

0 comments (0 inline, 0 general)

include/transport/networkplugin.h

➞

Show inline comments

@@ @@ -134,43 +134,78 @@ class NetworkPlugin { @@
 		/// Call this function when new authorization request arrived form legacy network
 		/// \param user XMPP JID of user for which this event occurs. You can get it from NetworkPlugin::handleLoginRequest(). (eg. "user%gmail.com@xmpp.domain.tld")
 		/// \param buddyName Name of legacy network buddy. (eg. "user2@gmail.com")
 		void handleAuthorization(const std::string &user, const std::string &buddyName);
 		/// Call this function when attention request arrived from legacy network.
 		/// \param user XMPP JID of user for which this event occurs. You can get it from NetworkPlugin::handleLoginRequest(). (eg. "user%gmail.com@xmpp.domain.tld")
 		/// \param buddyName Name of legacy network buddy. (eg. "user2@gmail.com")
 		/// \param message Message.
 		void handleAttention(const std::string &user, const std::string &buddyName, const std::string &message);
 		/// Called when XMPP user wants to connect legacy network.
 		/// You should connect it to legacy network and call handleConnected or handleDisconnected function later.
 		/// You should connect him to legacy network and call handleConnected or handleDisconnected function later.
 		/// \param user XMPP JID of user for which this event occurs.
 		/// \param legacyName Legacy network name of this user used for login.
 		/// \param password Legacy network password of this user.
 		/**
 			\msc
 			NetworkPlugin,YourNetworkPlugin,LegacyNetwork;
 			NetworkPlugin->YourNetworkPlugin [label="handleLoginRequest(...)", URL="\ref NetworkPlugin::handleLoginRequest()"];
 			YourNetworkPlugin->LegacyNetwork [label="connect the legacy network"];
 			--- [label="If password was valid and user is connected and logged in"];
 			YourNetworkPlugin<-LegacyNetwork [label="connected"];
 			YourNetworkPlugin->NetworkPlugin [label="handleConnected()", URL="\ref NetworkPlugin::handleConnected()"];
 			--- [label="else"];
 			YourNetworkPlugin<-LegacyNetwork [label="disconnected"];
 			YourNetworkPlugin->NetworkPlugin [label="handleDisconnected()", URL="\ref NetworkPlugin::handleDisconnected()"];
 			\endmsc
 		*/
 		virtual void handleLoginRequest(const std::string &user, const std::string &legacyName, const std::string &password) = 0;
 		/// Called when XMPP user wants to disconnect legacy network.
 		/// You should disconnect him from legacy network.
 		/// \param user XMPP JID of user for which this event occurs.
 		/// \param legacyName Legacy network name of this user used for login.
 		virtual void handleLogoutRequest(const std::string &user, const std::string &legacyName) = 0;
 		/// Called when XMPP user sends message to legacy network.
 		/// \param user XMPP JID of user for which this event occurs.
 		/// \param legacyName Legacy network name of buddy or room.
 		/// \param message Plain text message.
 		/// \param xhtml XHTML message.
 		virtual void handleMessageSendRequest(const std::string &user, const std::string &legacyName, const std::string &message, const std::string &xhtml = "") = 0;
 		/// Called when XMPP user requests VCard of buddy.
 		/// \param user XMPP JID of user for which this event occurs.
 		/// \param legacyName Legacy network name of buddy whose VCard is requested.
 		/// \param id ID which is associated with this request. You have to pass it to handleVCard function when you receive VCard.
 		/**
 			\msc
 			NetworkPlugin,YourNetworkPlugin,LegacyNetwork;
 			NetworkPlugin->YourNetworkPlugin [label="handleVCardRequest(...)", URL="\ref NetworkPlugin::handleVCardRequest()"];
 			YourNetworkPlugin->LegacyNetwork [label="start VCard fetching"];
 			YourNetworkPlugin<-LegacyNetwork [label="VCard fetched"];
 			YourNetworkPlugin->NetworkPlugin [label="handleVCard()", URL="\ref NetworkPlugin::handleVCard()"];
 			\endmsc
 		*/
 		virtual void handleVCardRequest(const std::string &/*user*/, const std::string &/*legacyName*/, unsigned int /*id*/) {}
 		/// Called when XMPP user updates his own VCard.
 		/// You should update the VCard in legacy network too.
 		/// \param user XMPP JID of user for which this event occurs.
 		/// \param photo Raw photo data.
 		virtual void handleVCardUpdatedRequest(const std::string &/*user*/, const std::string &/*photo*/) {}
 		virtual void handleJoinRoomRequest(const std::string &/*user*/, const std::string &/*room*/, const std::string &/*nickname*/, const std::string &/*pasword*/) {}
 		virtual void handleLeaveRoomRequest(const std::string &/*user*/, const std::string &/*room*/) {}
 		virtual void handleStatusChangeRequest(const std::string &/*user*/, int status, const std::string &statusMessage) {}
 		virtual void handleBuddyUpdatedRequest(const std::string &/*user*/, const std::string &/*buddyName*/, const std::string &/*alias*/, const std::string &/*groups*/) {}
 		virtual void handleBuddyRemovedRequest(const std::string &/*user*/, const std::string &/*buddyName*/, const std::string &/*groups*/) {}
 		virtual void handleBuddyBlockToggled(const std::string &/*user*/, const std::string &/*buddyName*/, bool /*blocked*/) {}
 		virtual void handleTypingRequest(const std::string &/*user*/, const std::string &/*buddyName*/) {}
 		virtual void handleTypedRequest(const std::string &/*user*/, const std::string &/*buddyName*/) {}
 		virtual void handleStoppedTypingRequest(const std::string &/*user*/, const std::string &/*buddyName*/) {}
 		virtual void handleAttentionRequest(const std::string &/*user*/, const std::string &/*buddyName*/, const std::string &/*message*/) {}

0 comments (0 inline, 0 general)