IPttEvents Interface Reference

Public Member Functions
void	SignInStarted ()
void	SignInSucceeded ()
void	SignInFailed ([in] CLIENT_ERROR ErrorCode)
void	SignOutStarted ()
void	SignOutComplete ()
void	SignInRequested ()
void	GetCanSignIn ([in, out] VARIANT_BOOL *pbVal)
void	ContactListChanged ()
void	HistoryChanged ()
void	MessageInBegin ([in] IMessage *pMessage)
void	MessageInEnd ([in] IMessage *pMessage)
void	MessageOutBegin ([in] IMessage *pMessage, [in] IContact *pContact)
void	MessageOutEnd ([in] IMessage *pMessage, [in] IContact *pContact)
void	MessageOutError ([in] IMessage *pMessage, [in] IContact *pContact)
void	AudioMessageInStart ([in] IAudioInMessage *pMessage, [in, out] VARIANT_BOOL *pbActivate)
void	AudioMessageInStop ([in] IAudioInMessage *pMessage)
void	PlayerAudioMessageStart ([in] IAudioMessage *pMessage)
void	PlayerAudioMessageStop ([in] IAudioMessage *pMessage)
void	PlayerAudioMessageProgress ([in] IAudioMessage *pMessage, [in] int iProgress)

Detailed Description

IPttEvents interface allows a client to receive events from control.

Member Function Documentation

SignInStarted()

void SignInStarted

(

)

Fired when sign-in process starts.

SignInSucceeded()

void SignInSucceeded

(

)

Fired when sign-in process completes successfully.

SignInFailed()

void SignInFailed

(

[in] CLIENT_ERROR

ErrorCode

)

Fired when sign-in process fails.

SignOutStarted()

void SignOutStarted

(

)

Fired when client sign-out process starts.

SignOutComplete()

void SignOutComplete

(

)

Fired when client sign-out process is over.

SignInRequested()

void SignInRequested

(

)

Fired when user initiates sign in process using object controls (using status popup menu). Hosting application is supposed to initiate sign in process after this event is received.

GetCanSignIn()

void GetCanSignIn

(

[in, out] VARIANT_BOOL *

pbVal

)

Fired to detect it hosting application can sign into network - that is, username and password are known. This is necessary to properly display "Online", "Away" etc commands' states in popup menus shown by control.

Parameters

pbVal

Return value. S_TRUE if unsername and password are available, S_FALSE otherwise.

ContactListChanged()

void ContactListChanged

(

)

Fired after new server contact list is received.

HistoryChanged()

void HistoryChanged

(

)

Fired when message history changes.

MessageInBegin()

void MessageInBegin

(

[in] IMessage *

pMessage

)

Fired when object starts receiving a message.

Parameters

pMessage

Message object. Can be used to get message ID, sender, author. Can't be deleted or marked as read or unread.

MessageInEnd()

void MessageInEnd

(

[in] IMessage *

pMessage

)

Fired when object stops receiving a message : audio, call alert or shared image

Parameters

pMessage

Message object. Can be used to get message ID, sender, author and other information. Can't be deleted or marked as read or unread. Can be downcasted to IAudioMessage, IAlertMessage or ISharedImage

MessageOutBegin()

void MessageOutBegin	(	[in] IMessage *	pMessage,
		[in] IContact *	pContact
	)

Fired when object starts sending a message to a contact.

Parameters

pMessage	Message object. Can't be deleted or marked as read or unread.
pContact	Receiver of the message.

MessageOutEnd()

void MessageOutEnd	(	[in] IMessage *	pMessage,
		[in] IContact *	pContact
	)

Fired when object finishes sending a message to a contact.

Parameters

pMessage	Message object. Can't be deleted or marked as read or unread.
pContact	Receiver of the message.

MessageOutError()

void MessageOutError	(	[in] IMessage *	pMessage,
		[in] IContact *	pContact
	)

Fired when object fails to start sending a message to a contact.

Parameters

pMessage	Message object. Can't be deleted or marked as read or unread.
pContact	Intended receiver of the message.

AudioMessageInStart()

void AudioMessageInStart	(	[in] IAudioInMessage *	pMessage,
		[in, out] VARIANT_BOOL *	pbActivate
	)

Fired when incoming message is ready to start playing.

Parameters

pMessage	Message object. Can be used to get message ID, sender, author. Can't be deleted or marked as read or unread.
pbActivate	Return value. Set to S_FALSE if message must not be activated.

AudioMessageInStop()

void AudioMessageInStop

(

[in] IAudioInMessage *

pMessage

)

Fired when incoming message stops playing.

Parameters

pMessage

Message object. Can be used to get message ID, sender, author. Can't be deleted or marked as read or unread.

PlayerAudioMessageStart()

void PlayerAudioMessageStart

(

[in] IAudioMessage *

pMessage

)

Fired when player starts playing audio message.

Parameters

pMessage

Message object.

PlayerAudioMessageStop()

void PlayerAudioMessageStop

(

[in] IAudioMessage *

pMessage

)

Fired when player stops playing audio message.

Parameters

pMessage

Message object.

PlayerAudioMessageProgress()

void PlayerAudioMessageProgress	(	[in] IAudioMessage *	pMessage,
		[in] int	iProgress
	)

Periodically fires by player during audio message playback.

Parameters

pMessage	Message object.
iProgress	Playback position, ms.