wosh::interfaces::communication::Communicator Class Reference [WOSH Interfaces]

Standard interface of Communicator (service). More...

#include <H:/WOSH/win32_vc2010/src/interfaces/communication/Communicator.h>

List of all members.

Public Member Functions
Communicator Interface
virtual bool	isUserReachable (const std::string &wosh_username) const =0
	Check if user is reachable (means online in most cases)
virtual bool	isUserRegistered (const std::string &username) const =0
	Check if user is registered to current server.
virtual int64	getUserLastSeen (const std::string &username) const =0
	Get the timestamp of last(seen) online-status of given user.
virtual WRESULT	sendMessageToUser (const std::string &wosh_username, const std::string &message)=0
	Send a text message to given (wosh) username.
virtual WRESULT	sendMessageTo (const std::string &custom_username, const std::string &message)=0
	Send a text message to given account name [example: asd123@gmail.com].
virtual WRESULT	notify (const Notification *notification, const Message *notification_message=NULL)=0
	Send a Notification translated into a text message.

---

Detailed Description

Standard interface of Communicator (service).

Version:

0.8.558

Id:

Communicator.h 3775 2011-01-01 16:38:17Z alex

Author:

Alessandro Polo

Definition at line 138 of file interfaces/communication/Communicator.h.

---

Member Function Documentation

virtual int64 wosh::interfaces::communication::Communicator::getUserLastSeen

(

const std::string &

username )

const [pure virtual]

Get the timestamp of last(seen) online-status of given user.

Parameters:

username

[in] wosh-username to lookup

Returns:

epoc timestamp if user is still online, negative epoch if user is actually offline; 0 means not available

Implemented in wosh::bundles::DesktopNotifierBundle, wosh::bundles::JabberGlooxBundle, wosh::bundles::TwitterCommBundle, and wosh::bundles::WebMessengerBundle.

virtual bool wosh::interfaces::communication::Communicator::isUserReachable

(

const std::string &

wosh_username )

const [pure virtual]

Check if user is reachable (means online in most cases)

Parameters:

wosh_username

[in] wosh-username to lookup

Returns:

true if user is online; false else

Implemented in wosh::bundles::DesktopNotifierBundle, wosh::bundles::JabberGlooxBundle, wosh::bundles::TwitterCommBundle, and wosh::bundles::WebMessengerBundle.

virtual bool wosh::interfaces::communication::Communicator::isUserRegistered

(

const std::string &

username )

const [pure virtual]

Check if user is registered to current server.

Parameters:

username

[in] wosh-username to lookup

Returns:

true if user is in friends' list

Implemented in wosh::bundles::DesktopNotifierBundle, wosh::bundles::JabberGlooxBundle, wosh::bundles::TwitterCommBundle, and wosh::bundles::WebMessengerBundle.

virtual WRESULT wosh::interfaces::communication::Communicator::notify	(	const Notification *	notification,
		const Message *	notification_message = NULL
	)		[pure virtual]

Send a Notification translated into a text message.

Parameters:

notification	[in] the Notification to communicate
notification_message	[in] message containing the Notification to communicate

Returns:

WRET_ERR_PARAM if account wasn't found, WRET_OK when message was sent, WRET_ERR_INTERNAL else.

Implemented in wosh::bundles::DesktopNotifierBundle, wosh::bundles::JabberGlooxBundle, wosh::bundles::TwitterCommBundle, and wosh::bundles::WebMessengerBundle.

virtual WRESULT wosh::interfaces::communication::Communicator::sendMessageTo	(	const std::string &	custom_username,
		const std::string &	message
	)		[pure virtual]

Send a text message to given account name [example: asd123@gmail.com].

Parameters:

custom_username	[in] recipent of the message
message	[in] message to be sent

Returns:

WRET_ERR_PARAM if account wasn't found, WRET_OK when message was sent, WRET_ERR_INTERNAL else.

Implemented in wosh::bundles::DesktopNotifierBundle, wosh::bundles::JabberGlooxBundle, wosh::bundles::TwitterCommBundle, and wosh::bundles::WebMessengerBundle.

virtual WRESULT wosh::interfaces::communication::Communicator::sendMessageToUser	(	const std::string &	wosh_username,
		const std::string &	message
	)		[pure virtual]

Send a text message to given (wosh) username.

Parameters:

wosh_username	[in] recipent of the message (as WOSH username)
message	[in] message to be sent

Returns:

WRET_ERR_PARAM if account wasn't found, WRET_OK when message was sent, WRET_ERR_INTERNAL else.

Implemented in wosh::bundles::DesktopNotifierBundle, wosh::bundles::JabberGlooxBundle, wosh::bundles::TwitterCommBundle, and wosh::bundles::WebMessengerBundle.

---

The documentation for this class was generated from the following file:

• interfaces/communication/Communicator.h