IClient Interface Reference

Client class default interface. More...

import "Skype4COM.idl";

List of all members.

Public Member Functions
HRESULT	Start ([in, defaultvalue(0)] VARIANT_BOOL Minimized,[in, defaultvalue(0)] VARIANT_BOOL Nosplash)
	This command starts the Skype client.
HRESULT	Minimize ()
	This command minimizes (hides) the Skype client.
HRESULT	Shutdown ()
	This command closes the Skype client.
HRESULT	OpenProfileDialog ()
	This command opens the profile window for the current user.
HRESULT	OpenUserInfoDialog ([in] BSTR Username)
	This command opens the information window for the current user.
HRESULT	OpenConferenceDialog ()
	This command opens the create conference window.
HRESULT	OpenSearchDialog ()
	This command opens the search contacts window.
HRESULT	OpenOptionsDialog ([in] BSTR Page)
	This command opens the options window.
HRESULT	OpenCallHistoryTab ()
	This command brings the call history tab into focus.
HRESULT	OpenContactsTab ()
	This command brings the contacts tab into focus.
HRESULT	OpenDialpadTab ()
	This command brings the dialpad tab into focus.
HRESULT	OpenSendContactsDialog ([in, defaultvalue("")] BSTR Username)
	This command opens the send contacts window.
HRESULT	OpenBlockedUsersDialog ()
	This command opens the blocked users window.
HRESULT	OpenImportContactsWizard ()
	This command opens the import contacts window.
HRESULT	OpenGettingStartedWizard ()
	This command opens the getting started wizard.
HRESULT	OpenAuthorizationDialog ([in] BSTR Username)
	This command opens the user authorization window.
HRESULT	OpenDialog ([in] BSTR Name,[in, defaultvalue("")] BSTR Param1,[in, defaultvalue("")] BSTR Param2)
	This command opens the user interface window.
HRESULT	OpenVideoTestDialog ()
	This command opens the video test window.
HRESULT	OpenAddContactDialog ([in, defaultvalue("")] BSTR Username)
	This command opens the "Add a Contact" window.
HRESULT	OpenMessageDialog ([in] BSTR Username,[in, defaultvalue("")] BSTR Text)
	This command opens the "Send an IM Message" window.
HRESULT	OpenFileTransferDialog ([in] BSTR User,[in] BSTR Folder)
	This command opens the file transfer window.
HRESULT	Focus ()
	This command brings the client window into focus.
HRESULT	ButtonPressed ([in] BSTR Key)
	This command sends a button pressed notification event.
HRESULT	ButtonReleased ([in] BSTR Key)
	This command sends a button released notification event.
HRESULT	OpenSmsDialog ([in] BSTR SmsId)
	This command opens SMS window.
HRESULT	CreateEvent ([in] BSTR EventId,[in] BSTR Caption,[in] BSTR Hint,[out, retval] IPluginEvent **pEvent)
	This command creates a plug-in event.
HRESULT	CreateMenuItem ([in] BSTR MenuItemId,[in] TPluginContext PluginContext,[in] BSTR CaptionText,[in, defaultvalue("")] BSTR HintText,[in, defaultvalue("")] BSTR IconPath,[in, defaultvalue(-1)] VARIANT_BOOL Enabled,[in, defaultvalue(pluginContactTypeAll)] TPluginContactType ContactType,[in, defaultvalue(0)] VARIANT_BOOL MultipleContacts,[out, retval] IPluginMenuItem **pMenuItem)
	This command creates a menu item for a plug-in.
HRESULT	OpenLiveTab ()
	This command brings the Live tab into focus.
Properties
VARIANT_BOOL	IsRunning [get]
	This command queries the running status of the Skype client.
BSTR	Wallpaper [get, set]
	This command queries/sets path to wallpaper bitmap.

---

Detailed Description

Client class default interface.

---

Member Function Documentation

HRESULT ButtonPressed

(

[in] BSTR

Key

)

This command sends a button pressed notification event.

Parameters:

[in]

Key

is a button key (0-9, A-Z, #, *, UP, DOWN, YES, NO, SKYPE, PAGEUP, PAGEDOWN).

HRESULT ButtonReleased

(

[in] BSTR

Key

)

This command sends a button released notification event.

Parameters:

[in]

Key

is button key (0-9, A-Z, #, *, UP, DOWN, YES, NO, SKYPE, PAGEUP, PAGEDOWN).

HRESULT CreateEvent	(	[in] BSTR	EventId,
		[in] BSTR	Caption,
		[in] BSTR	Hint,
		[out,retval] IPluginEvent **	pEvent
	)

This command creates a plug-in event.

Parameters:

[in]	EventId	is a unique identifier for the plug-in event.
[in]	Caption	event contains caption text.
[in]	Hint	event contains hint text.
[out]	pEvent	receives the interface pointer for the PluginEvent object.

HRESULT CreateMenuItem	(	[in] BSTR	MenuItemId,
		[in] TPluginContext	PluginContext,
		[in] BSTR	CaptionText,
		[in,defaultvalue("")] BSTR	HintText,
		[in, defaultvalue("")] BSTR	IconPath,
		[in, defaultvalue(-1)] VARIANT_BOOL	Enabled,
		[in, defaultvalue(pluginContactTypeAll)] TPluginContactType	ContactType,
		[in, defaultvalue(0)] VARIANT_BOOL	MultipleContacts,
		[out,retval] IPluginMenuItem **	pMenuItem
	)

This command creates a menu item for a plug-in.

Parameters:

[in]	MenuItemId	is a unique identifier for the menu item.
[in]	PluginContext	contains the plug-in context.
[in]	CaptionText	contains the caption text for the menu item.
[in]	HintText	contains the hint text for the menu item (optional).
[in]	IconPath	is the path to an icon file (optional).
[in]	Enabled	defines the initial state of the menu item (optional - default enabled).
[in]	ContactType	is the contact type and is relevant only in theTPluginContext::pluginContextContact context (optional - default all contacts).
[in]	MultipleContacts	defines whether multiple contacts are allowed for this menu item (optional - default does not allow multiple contacts).
[out]	pMenuItem	receives the interface pointer for the PluginMenuItem object.

See also:

TPluginContext

HRESULT OpenAddContactDialog

(

[in, defaultvalue("")] BSTR

Username

)

This command opens the "Add a Contact" window.

Parameters:

[in]

Username

is an optional field for the Skypename of the contact.

HRESULT OpenAuthorizationDialog

(

[in] BSTR

Username

)

This command opens the user authorization window.

Parameters:

[in]

Username

contains the Skypename of the user.

HRESULT OpenDialog	(	[in] BSTR	Name,
		[in, defaultvalue("")] BSTR	Param1,
		[in, defaultvalue("")] BSTR	Param2
	)

This command opens the user interface window.

Parameters:

[in]	Name	The Name field contains the name of the window.
[in]	Param1	is an optional parameter.
[in]	Param2	is an optional parameter.

HRESULT OpenFileTransferDialog	(	[in] BSTR	Username,
		[in] BSTR	Folder
	)

This command opens the file transfer window.

Parameters:

[in]	Username	contains the Skypename of the user
[in]	Folder	contains the folder name to transfer.

HRESULT OpenMessageDialog	(	[in] BSTR	Username,
		[in, defaultvalue("")] BSTR	Text
	)

This command opens the "Send an IM Message" window.

Parameters:

[in]	Username	contains the message target.
[in]	Text	is an optional field which can contain message text.

HRESULT OpenOptionsDialog

(

[in] BSTR

Page

)

This command opens the options window.

Parameters:

[in]

Page

contains the page to open.

HRESULT OpenSendContactsDialog

(

[in, defaultvalue("")] BSTR

Username

)

This command opens the send contacts window.

Parameters:

[in]

Username

is an optional field for the Skypename of the user.

HRESULT OpenSmsDialog

(

[in] BSTR

SmsId

)

This command opens SMS window.

Parameters:

[in]

SmsId

is SMS message id.

HRESULT OpenUserInfoDialog

(

[in] BSTR

Username

)

This command opens the information window for the current user.

Parameters:

[in]

Username

contains the Skypename of the user

HRESULT Start	(	[in, defaultvalue(0)] VARIANT_BOOL	Minimized,
		[in, defaultvalue(0)] VARIANT_BOOL	Nosplash
	)

This command starts the Skype client.

Parameters:

[in]	Minimized	if True, Skype is minimized in the system tray.
[in]	Nosplash	if True, Skype does not display a splash screen on start up.

---

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

• Skype4COM.idl