Package Skype4Py :: Module client :: Class IClient
[frames] | no frames]

Class IClient

source code

object --+
         |
        IClient

Represents a Skype client. Access using ISkype.Client.

Instance Methods
 
__init__(self, Skype)
__init__.
source code
 
ButtonPressed(self, Key)
Sends button button pressed to client.
source code
 
ButtonReleased(self, Key)
Sends button released event to client.
source code
IPluginEvent
CreateEvent(self, EventId, Caption, Hint)
Creates a custom event displayed in Skype client's events pane.
source code
IPluginMenuItem
CreateMenuItem(self, MenuItemId, PluginContext, CaptionText, HintText=u'', IconPath='', Enabled=True, ContactType='all', MultipleContacts=False)
Creates custom menu item in Skype client's "Do More" menus.
source code
 
Focus(self)
Brings the client window into focus.
source code
 
Minimize(self)
Hides Skype application window.
source code
 
OpenAddContactDialog(self, Username='')
Opens "Add a Contact" dialog.
source code
 
OpenAuthorizationDialog(self, Username)
Opens authorization dialog.
source code
 
OpenBlockedUsersDialog(self)
Opens blocked users dialog.
source code
 
OpenCallHistoryTab(self)
Opens call history tab.
source code
 
OpenConferenceDialog(self)
Opens create conference dialog.
source code
 
OpenContactsTab(self)
Opens contacts tab.
source code
 
OpenDialog(self, Name, *Params)
Open dialog.
source code
 
OpenDialpadTab(self)
Opens dial pad tab.
source code
 
OpenFileTransferDialog(self, Username, Folder)
Opens file transfer dialog.
source code
 
OpenGettingStartedWizard(self)
Opens getting started wizard.
source code
 
OpenImportContactsWizard(self)
Opens import contacts wizard.
source code
 
OpenLiveTab(self)
OpenLiveTab.
source code
 
OpenMessageDialog(self, Username, Text='')
Opens "Send an IM Message" dialog.
source code
 
OpenOptionsDialog(self, Page='')
Opens options dialog.
source code
 
OpenProfileDialog(self)
Opens current user profile dialog.
source code
 
OpenSearchDialog(self)
Opens search dialog.
source code
 
OpenSendContactsDialog(self, Username='')
Opens send contacts dialog.
source code
 
OpenSmsDialog(self, SmsId)
Opens SMS window
source code
 
OpenUserInfoDialog(self, Username)
Opens user information dialog.
source code
 
OpenVideoTestDialog(self)
Opens video test dialog.
source code
 
Shutdown(self)
Closes Skype application.
source code
 
Start(self, Minimized=False, Nosplash=False)
Starts Skype application.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
bool IsRunning
Tells if Skype client is running.
unicode Wallpaper
Path to client wallpaper bitmap.
Window state WindowState
Client window state.

Inherited from object: __class__

Method Details

__init__(self, Skype)
(Constructor)

source code 

__init__.

Parameters:
Overrides: object.__init__

ButtonPressed(self, Key)

source code 

Sends button button pressed to client.

Parameters:
  • Key (unicode) - Key

ButtonReleased(self, Key)

source code 

Sends button released event to client.

Parameters:
  • Key (unicode) - Key

CreateEvent(self, EventId, Caption, Hint)

source code 

Creates a custom event displayed in Skype client's events pane.

Parameters:
  • EventId (unicode) - Unique identifier for the event.
  • Caption (unicode) - Caption text.
  • Hint (unicode) - Hint text. Shown when mouse hoovers over the event.
Returns: IPluginEvent
Event object.

CreateMenuItem(self, MenuItemId, PluginContext, CaptionText, HintText=u'', IconPath='', Enabled=True, ContactType='all', MultipleContacts=False)

source code 

Creates custom menu item in Skype client's "Do More" menus.

Parameters:
  • MenuItemId (unicode) - Unique identifier for the menu item.
  • PluginContext (Plug-in context) - Menu item context. Allows to choose in which client windows will the menu item appear.
  • CaptionText (unicode) - Caption text.
  • HintText (unicode) - Hint text (optional). Shown when mouse hoovers over the menu item.
  • IconPath (unicode) - Path to the icon (optional).
  • Enabled (bool) - Initial state of the menu item. True by default.
  • ContactType (Plug-in contact type) - In case of pluginContextContact tells which contacts the menu item should appear for. Defaults to pluginContactTypeAll.
  • MultipleContacts (bool) - Set to True if multiple contacts should be allowed (defaults to False).
Returns: IPluginMenuItem
Menu item object.

OpenAddContactDialog(self, Username='')

source code 

Opens "Add a Contact" dialog.

Parameters:
  • Username (unicode) - Optional Skypename of the contact.

OpenAuthorizationDialog(self, Username)

source code 

Opens authorization dialog.

Parameters:
  • Username (unicode) - Skypename of the user to authenticate.

OpenDialog(self, Name, *Params)

source code 

Open dialog. Use this method to open dialogs added in newer Skype versions if there is no dedicated method in Skype4Py.

Parameters:
  • Name (unicode) - Dialog name.
  • Params (unicode) - One or more optional parameters.

OpenFileTransferDialog(self, Username, Folder)

source code 

Opens file transfer dialog.

Parameters:
  • Username (unicode) - Skypename of the user.
  • Folder (unicode) - Path to initial directory.

OpenMessageDialog(self, Username, Text='')

source code 

Opens "Send an IM Message" dialog.

Parameters:
  • Username (unicode) - Message target.
  • Text (unicode) - Message text.

OpenOptionsDialog(self, Page='')

source code 

Opens options dialog.

Parameters:
  • Page (unicode) - Page name to open.

OpenSendContactsDialog(self, Username='')

source code 

Opens send contacts dialog.

Parameters:
  • Username (unicode) - Optional Skypename of the user.

OpenSmsDialog(self, SmsId)

source code 

Opens SMS window

Parameters:
  • SmsId (int) - SMS message Id.

OpenUserInfoDialog(self, Username)

source code 

Opens user information dialog.

Parameters:
  • Username (unicode) - Skypename of the user.

Start(self, Minimized=False, Nosplash=False)

source code 

Starts Skype application.

Parameters:
  • Minimized (bool) - If True, Skype is started minized in system tray.
  • Nosplash (bool) - If True, no splash screen is displayed upon startup.

Property Details

IsRunning

Tells if Skype client is running.

Get Method:
_GetIsRunning(self)
Type:
bool

Wallpaper

Path to client wallpaper bitmap.

Get Method:
_GetWallpaper(self)
Set Method:
_SetWallpaper(self, value)
Type:
unicode

WindowState

Client window state.

Get Method:
_GetWindowState(self)
Set Method:
_SetWindowState(self, value)
Type:
Window state