IPtt Interface Reference

Inherits IDispatch.

Inherited by IPtt2.

Public Member Functions
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)

Properties
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

IPtt interface manages control behavior. It allows to configure login server, supernode list, user credentials etc.

Member Function Documentation

SignIn()

HRESULT SignIn	(	[in] BSTR	bstrUsername,
		[in] BSTR	bstrPassword,
		[in] VARIANT_BOOL	bPasswordHash
	)

Sign in to network. When sign in succeeds of fails, appropriate event is fired on IPttEvents interface.

Parameters

bstrUsername	Username.
bstrPassword	Password.
bPasswordHash	bstrPassword contains password MD5 hash instead of actial password value.

SignOut()

HRESULT SignOut

(

)

Sign out. When sign out is complete, an appropriate event is fired on IPttEvents interface.

Cancel()

HRESULT Cancel

(

)

Cancel signing in if it's in progress. After signing in is halted, an event is fired on IPttEvents interface.

ShowSettingsDialog()

HRESULT ShowSettingsDialog

(

[in] long

lParentWindow

)

Show "Settings" dialog. Dialog is shown modally, calling thread is blocked intil dialog is closed.

Parameters

lParentWindow

Dialog owner window. If zero is passed, root parent window is used.

ShowAboutDialog()

HRESULT ShowAboutDialog

(

[in] long

lParentWindow

)

Show "About" dialog. Dialog is shown modally, calling thread is blocked intil dialog is closed.

Parameters

lParentWindow

Dialog owner window. If zero is passed, root parent window is used.

ShowFeedbackDialog()

HRESULT ShowFeedbackDialog

(

[in] long

lParentWindow

)

Show "Report a problem" dialog. Dialog is shown modally, calling thread is blocked intil dialog is closed.

Parameters

lParentWindow

Dialog owner window. If zero is passed, root parent window is used.

ShowPasswordWizard()

HRESULT ShowPasswordWizard

(

[in] long

lParentWindow

)

Show "Change password" wizard. Wizard is shown modally, calling thread is blocked intil dialog is closed. Password wizard can only be used in server contacts mode. Password wizard is available inly in signed in state.

Parameters

lParentWindow

Wizard owner window. If zero is passed, root parent window is used.

Returns

S_OK if wizard was shown, S_FALSE otherwise.

BeginMessage()

HRESULT BeginMessage

(

[in] SAFEARRAY BSTR

Users

)

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.

EndMessage()

HRESULT EndMessage

(

)

Stop sending audio message.

RepeatLastMessage()

HRESULT RepeatLastMessage

(

)

Repeat last message.

BeginMessage2()

HRESULT BeginMessage2

(

[in, out] SAFEARRAY BSTR *

Users

)

Start sending audio message. The sole purpose of this function is to support Visual Basic 6.

Parameters

Users

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

UpdateContacts()

HRESULT UpdateContacts

(

)

Request contact list from server. When server API is used to change contact list, it takes some some before new contact list arrives to a client. This function can be used to request new contact list instantly.

Returns

S_OK if success, S_FALSE if user is not signed in.

ShowContacts()

HRESULT ShowContacts

(

)

Show full contact list. This method closes history view or list of group/channel users if one is opened. Works when signed in only.

Returns

S_OK if success, S_FALSE if contact does not exist or is not present in active view.

OpenHistory()

HRESULT OpenHistory

(

IContact *

pContact

)

Shows message history of a contact.

Parameters

pContact

Contact whose history is to be shown. If NULL, all messages stored in history are displayed and filter edit box is shown.

Returns

S_OK if success, S_FALSE if contact does not exist.

CloseHistory()

HRESULT CloseHistory

(

)

Hides history view.

ExpandContact()

HRESULT ExpandContact

(

IContact *

pContact

)

Show list of channel or group users. Works when signed in only.

Parameters

pContact

IGroup or IChannel to be expanded.

Returns

S_OK if success, S_FALSE if contact does not exist or can't be expanded.

SelectContact()

HRESULT SelectContact

(

IContact *

pContact

)

Set focus to contact. Works when signed in only.

Parameters

pContact

Contact to be selected.

Returns

S_OK if success, S_FALSE if contact does not exist or is not present in active view.

Property Documentation

NetworkStatus

NETWORK_STATUS NetworkStatus

getproperty

Get current network status.

Parameters

pVal	Return value.

OnlineStatus

ONLINE_STATUS OnlineStatus

getsetproperty

Set online online status.

Parameters

nVal

Status.

Get current online status.

Parameters

pVal	Return value.

Username

BSTR Username

getproperty

Get username used to sign in last time.

Parameters

bstrpVal

Return value.

Password

BSTR Password

getproperty

Get password used to sign in last time. Hash value is returned instead of actual value.

Parameters

bstrpVal

Return value.

Contacts

IContacts Contacts

getproperty

Get IContacts interface.

Parameters

ppVal

Return value.

Network

INetwork Network

getproperty

Get INetwork interface.

Parameters

ppVal

Return value.

Settings

ISettings Settings

getproperty

Get ISettings interface.

Parameters

ppVal

Return value. Developer may query ISettings2 interface if required

History

IHistory History([in] BSTR bstrFilter)

getproperty

Get message history.

Parameters

bstrFilter	Filter string. Pass empty string to collect history for all contacts.
ppVal	Return value.

AudioPlayer

IAudioPlayer AudioPlayer

getproperty

Get player.

Parameters

ppVal

Return value.

Customization

ICustomization Customization

getproperty

Get ICustomization interface.

Parameters

ppVal

Return value.

VoxActive

VARIANT_BOOL VoxActive

getsetproperty

Check if VOX feature is active.

Parameters

pbVal

Return value.

Activate or deactivate VOX.

Parameters

bVal	New value.

StatusText

BSTR StatusText

getsetproperty

Set custom status text.

Parameters

nVal	Status text.

Get current status text.

Parameters

pVal	Return value.