IPtt2 Interface Reference

Inherits IPtt.

Inherited by IPtt3.

Public Member Functions
HRESULT	BeginMessageEx ([in] SAFEARRAY BSTR Users, [in] BSTR bstrExternalId)
HRESULT	SendCallAlert ([in] IContact *pContact, [in] BSTR bstrText, [in] BSTR bstrExternalId)
HRESULT	ShareImage ([in] IContact *pContact, [in] BSTR bstrText, [in] BSTR bstrExternalId)
HRESULT	GetSoloContact ([out, retval] IContact **ppVal)
HRESULT	UpdateSoloContact ([in] IContact *pContact)
Public Member Functions inherited from IPtt
HRESULT	SignIn ([in] BSTR bstrUsername, [in] BSTR bstrPassword, [in] VARIANT_BOOL bPasswordHash)
HRESULT	SignOut ()
HRESULT	Cancel ()
HRESULT	ShowSettingsDialog ([in] long lParentWindow)
HRESULT	ShowAboutDialog ([in] long lParentWindow)
HRESULT	ShowFeedbackDialog ([in] long lParentWindow)
HRESULT	ShowPasswordWizard ([in] long lParentWindow)
HRESULT	BeginMessage ([in] SAFEARRAY BSTR Users)
HRESULT	EndMessage ()
HRESULT	RepeatLastMessage ()
HRESULT	BeginMessage2 ([in, out] SAFEARRAY BSTR *Users)
HRESULT	UpdateContacts ()
HRESULT	ShowContacts ()
HRESULT	OpenHistory (IContact *pContact)
HRESULT	CloseHistory ()
HRESULT	ExpandContact (IContact *pContact)
HRESULT	SelectContact (IContact *pContact)

Additional Inherited Members
Properties inherited from IPtt
NETWORK_STATUS	NetworkStatus [get]
ONLINE_STATUS	OnlineStatus [get, set]
BSTR	Username [get]
BSTR	Password [get]
IContacts	Contacts [get]
INetwork	Network [get]
ISettings	Settings [get]
IHistory	History ([in] BSTR bstrFilter) [get]
IAudioPlayer	AudioPlayer [get]
ICustomization	Customization [get]
VARIANT_BOOL	VoxActive [get, set]
BSTR	StatusText [get, set]

Detailed Description

IPtt2 interface extends IPtt, allows external message ids

Member Function Documentation

BeginMessageEx()

HRESULT BeginMessageEx	(	[in] SAFEARRAY BSTR	Users,
		[in] BSTR	bstrExternalId
	)

Start sending audio message.

Parameters

Users	List of message recipients' names and/or ID's. If list is empty, message is sent to all selected users.
bstrExternalId	External message id

SendCallAlert()

HRESULT SendCallAlert	(	[in] IContact *	pContact,
		[in] BSTR	bstrText,
		[in] BSTR	bstrExternalId
	)

Send call alert

Parameters

pContact	Receiver of the message
bstrText	Alert message
bstrExternalId	External alert id

ShareImage()

HRESULT ShareImage	(	[in] IContact *	pContact,
		[in] BSTR	bstrText,
		[in] BSTR	bstrExternalId
	)

Send shared image

Parameters

pContact	Receiver of the message, IChannel or IUser
bstrText	Path to image file
bstrExternalId	External image id

GetSoloContact()

HRESULT GetSoloContact

(

[out, retval] IContact **

ppVal

)

Get active solo contact

Parameters

ppVal

Return value

UpdateSoloContact()

HRESULT UpdateSoloContact

(

[in] IContact *

pContact

)

Set new solo contact

Parameters

pContact

New solo contact: IGroup, IChannel or IUser. Set NULL value to deactivate solo