Home       Trees       Indices       Help   
Skype4Py
Package Skype4Py :: Module client :: Class Client
[frames] | no frames]

Class Client

source code

object --+
         |
        Client
Represents a Skype client. Access using skype.Skype.Client.
Instance Methods
 
__init__(self, Skype)
__init__.		 source code
 
ButtonPressed(self, Key)
This command sends a button pressed notification event.		 source code
 
ButtonReleased(self, Key)
This command sends a button released notification event.		 source code
PluginEvent
CreateEvent(self, EventId, Caption, Hint)
Creates a custom event displayed in Skype client's events pane.		 source code
PluginMenuItem
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=u'')
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.
str Wallpaper
Path to client wallpaper bitmap.
enums.wnd* 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 
This command sends a button pressed notification event.
Parameters:
  • Key (str) - Button key [0-9, A-Z, #, *, UP, DOWN, YES, NO, SKYPE, PAGEUP, PAGEDOWN].

ButtonReleased(self, Key)

source code 
This command sends a button released notification event.
Parameters:
  • Key (str) - Button key [0-9, A-Z, #, *, UP, DOWN, YES, NO, SKYPE, PAGEUP, PAGEDOWN].

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: PluginEvent
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 (enums.pluginContext*) - 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 (enums.pluginContactType*) - In case of enums.pluginContextContact tells which contacts the menu item should appear for. Defaults to enums.pluginContactTypeAll.
  • MultipleContacts (bool) - Set to True if multiple contacts should be allowed (defaults to False).
Returns: PluginMenuItem
Menu item object.

OpenAddContactDialog(self, Username='')

source code 
Opens "Add a Contact" dialog.
Parameters:
  • Username (str) - Optional Skypename of the contact.

OpenAuthorizationDialog(self, Username)

source code 
Opens authorization dialog.
Parameters:
  • Username (str) - 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 (str) - Dialog name.
  • Params (unicode) - One or more optional parameters.

OpenFileTransferDialog(self, Username, Folder)

source code 
Opens file transfer dialog.
Parameters:
  • Username (str) - Skypename of the user.
  • Folder (str) - Path to initial directory.

OpenMessageDialog(self, Username, Text=u'')

source code 
Opens "Send an IM Message" dialog.
Parameters:
  • Username (str) - Message target.
  • Text (unicode) - Message text.

OpenOptionsDialog(self, Page='')

source code 
Opens options dialog.
Parameters:
  • Page (str) - Page name to open.

See Also: See https://developer.skype.com/Docs/ApiDoc/OPEN_OPTIONS for known Page values.

OpenSendContactsDialog(self, Username='')

source code 
Opens send contacts dialog.
Parameters:
  • Username (str) - 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 (str) - Skypename of the user.

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

source code 
Starts Skype application.
Parameters:
  • Minimized (bool) - If True, Skype is started minimized 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:
str

WindowState

Client window state.
Get Method:
_GetWindowState(self)
Set Method:
_SetWindowState(self, Value)
Type:
enums.wnd*

   Home       Trees       Indices       Help   
Skype4Py
Generated by Epydoc 3.0.1 on Sat Sep 26 16:13:05 2009 http://epydoc.sourceforge.net