Package Skype4Py :: Module skype :: Class ISkype
[frames] | no frames]

Class ISkype

source code

             object --+    
                      |    
utils.EventHandlingBase --+
                          |
                         ISkype

The main class which you have to instatinate to get access to Skype client.

  1. Usage.

    You should access this class using the alias at the package level:

       import Skype4Py
    
       skype = Skype4Py.Skype()
    

    For possible constructor arguments, read the ISkype.__init__ description.

  2. Events.

    This class provides events.

    The events names and their arguments lists can be found in ISkypeEvents class.

    The usage of events is described in EventHandlingBase class which is a superclass of this class. Follow the link for more information.

Instance Methods
 
__init__(self, Events=None, **Options)
Initializes the object.
source code
 
__del__(self)
Frees all resources.
source code
bool
ApiSecurityContextEnabled(self, Context)
Queries if an API security context for Internet Explorer is enabled.
source code
IApplication
Application(self, Name)
Queries an application object.
source code
int
AsyncSearchUsers(self, Target)
Asynchronously searches for Skype users.
source code
 
Attach(self, Protocol=5, Wait=True)
Establishes a connection to Skype.
source code
ICall
Call(self, Id=0)
Queries a call object.
source code
tuple of ICall
Calls(self, Target='')
Queries calls in call history.
source code
 
ChangeUserStatus(self, Val)
Changes the online status for the current user.
source code
IChat
Chat(self, Name='')
Queries a chat object.
source code
 
ClearCallHistory(self, Username='ALL', Type='ALL')
Clears the call history.
source code
 
ClearChatHistory(self)
Clears the chat history.
source code
 
ClearVoicemailHistory(self)
Clears the voicemail history.
source code
ICommand
Command(self, Command, Reply=u'', Block=False, Timeout=30000, Id=-1)
Creates an API command object.
source code
IConference
Conference(self, Id=0)
Queries a call conference object.
source code
IChat
CreateChatUsingBlob(self, Blob)
Returns existing or joins a new chat using given blob.
source code
IChat
CreateChatWith(self, *Usernames)
Creates a chat with one or more users.
source code
IGroup
CreateGroup(self, GroupName)
Creates a custom contact group.
source code
ISmsMessage
CreateSms(self, MessageType, *TargetNumbers)
Creates an SMS message.
source code
 
DeleteGroup(self, GroupId)
Deletes a custom contact group.
source code
 
EnableApiSecurityContext(self, Context)
Enables an API security context for Internet Explorer scripts.
source code
IChat
FindChatUsingBlob(self, Blob)
Returns existing chat using given blob.
source code
IVoicemail
Greeting(self, Username='')
Queries the greeting used as voicemail.
source code
IChatMessage
Message(self, Id=0)
Queries a chat message object.
source code
tuple of IChatMessage
Messages(self, Target='')
Queries chat messages which were sent/received by the user.
source code
ICall
PlaceCall(self, *Targets)
Places a call to a single user or creates a conference call.
source code
bool
Privilege(self, Name)
Queries the Skype services (privileges) enabled for the Skype client.
source code
unicode or None
Profile(self, Property, Set=None)
Queries/sets user profile properties.
source code
unicode or None
Property(self, ObjectType, ObjectId, PropName, Set=None)
Queries/sets the properties of an object.
source code
 
ResetCache(self)
Deletes all command cache entries.
source code
tuple of IUser
SearchForUsers(self, Target)
Searches for users.
source code
 
SendCommand(self, Command)
Sends an API command.
source code
IChatMessage
SendMessage(self, Username, Text)
Sends a chat message.
source code
ISmsMessage
SendSms(self, *TargetNumbers, **Properties)
Creates and sends an SMS message.
source code
IVoicemail
SendVoicemail(self, Username)
Sends a voicemail to a specified user.
source code
IUser
User(self, Username='')
Queries a user object.
source code
unicode or None
Variable(self, Name, Set=None)
Queries/sets Skype general parameters.
source code
IVoicemail
Voicemail(self, Id)
Queries the voicemail object.
source code

Inherited from utils.EventHandlingBase: RegisterEventHandler, UnregisterEventHandler

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

Instance Variables
callable OnApplicationConnecting
Event handler for ISkypeEvents.ApplicationConnecting event.
callable OnApplicationDatagram
Event handler for ISkypeEvents.ApplicationDatagram event.
callable OnApplicationReceiving
Event handler for ISkypeEvents.ApplicationReceiving event.
callable OnApplicationSending
Event handler for ISkypeEvents.ApplicationSending event.
callable OnApplicationStreams
Event handler for ISkypeEvents.ApplicationStreams event.
callable OnAsyncSearchUsersFinished
Event handler for ISkypeEvents.AsyncSearchUsersFinished event.
callable OnAttachmentStatus
Event handler for ISkypeEvents.AttachmentStatus event.
callable OnAutoAway
Event handler for ISkypeEvents.AutoAway event.
callable OnCallDtmfReceived
Event handler for ISkypeEvents.CallDtmfReceived event.
callable OnCallHistory
Event handler for ISkypeEvents.CallHistory event.
callable OnCallInputStatusChanged
Event handler for ISkypeEvents.CallInputStatusChanged event.
callable OnCallSeenStatusChanged
Event handler for ISkypeEvents.CallSeenStatusChanged event.
callable OnCallStatus
Event handler for ISkypeEvents.CallStatus event.
callable OnCallTransferStatusChanged
Event handler for ISkypeEvents.CallTransferStatusChanged event.
callable OnCallVideoReceiveStatusChanged
Event handler for ISkypeEvents.CallVideoReceiveStatusChanged event.
callable OnCallVideoSendStatusChanged
Event handler for ISkypeEvents.CallVideoSendStatusChanged event.
callable OnCallVideoStatusChanged
Event handler for ISkypeEvents.CallVideoStatusChanged event.
callable OnChatMemberRoleChanged
Event handler for ISkypeEvents.ChatMemberRoleChanged event.
callable OnChatMembersChanged
Event handler for ISkypeEvents.ChatMembersChanged event.
callable OnChatWindowState
Event handler for ISkypeEvents.ChatWindowState event.
callable OnClientWindowState
Event handler for ISkypeEvents.ClientWindowState event.
callable OnCommand
Event handler for ISkypeEvents.Command event.
callable OnConnectionStatus
Event handler for ISkypeEvents.ConnectionStatus event.
callable OnContactsFocused
Event handler for ISkypeEvents.ContactsFocused event.
callable OnError
Event handler for ISkypeEvents.Error event.
callable OnFileTransferStatusChanged
Event handler for ISkypeEvents.FileTransferStatusChanged event.
callable OnGroupDeleted
Event handler for ISkypeEvents.GroupDeleted event.
callable OnGroupExpanded
Event handler for ISkypeEvents.GroupExpanded event.
callable OnGroupUsers
Event handler for ISkypeEvents.GroupUsers event.
callable OnGroupVisible
Event handler for ISkypeEvents.GroupVisible event.
callable OnMessageHistory
Event handler for ISkypeEvents.MessageHistory event.
callable OnMessageStatus
Event handler for ISkypeEvents.MessageStatus event.
callable OnMute
Event handler for ISkypeEvents.Mute event.
callable OnNotify
Event handler for ISkypeEvents.Notify event.
callable OnOnlineStatus
Event handler for ISkypeEvents.OnlineStatus event.
callable OnPluginEventClicked
Event handler for ISkypeEvents.PluginEventClicked event.
callable OnPluginMenuItemClicked
Event handler for ISkypeEvents.PluginMenuItemClicked event.
callable OnReply
Event handler for ISkypeEvents.Reply event.
callable OnSmsMessageStatusChanged
Event handler for ISkypeEvents.SmsMessageStatusChanged event.
callable OnSmsTargetStatusChanged
Event handler for ISkypeEvents.SmsTargetStatusChanged event.
callable OnUserMood
Event handler for ISkypeEvents.UserMood event.
callable OnUserStatus
Event handler for ISkypeEvents.UserStatus event.
callable OnVoicemailStatus
Event handler for ISkypeEvents.VoicemailStatus event.
callable OnWallpaperChanged
Event handler for ISkypeEvents.WallpaperChanged event.
Properties
tuple of ICall ActiveCalls
Queries a list of active calls.
tuple of IChat ActiveChats
Queries a list of active chats.
tuple of IFileTransfer ActiveFileTransfers
Queries currently active file transfers.
int ApiDebugLevel
Queries/sets the debug level of the underlying API.
unicode ApiWrapperVersion
Returns Skype4Py version.
Attachment status AttachmentStatus
Queries the attachment status of the Skype client.
tuple of IChat BookmarkedChats
Queries a list of bookmarked chats.
bool Cache
Queries/sets the status of internal cache.
tuple of IChat Chats
Queries a list of chats.
IClient Client
Queries the user interface control object.
bool CommandId
Queries/sets the status of automatic command identifiers.
tuple of IConference Conferences
Queries a list of call conferences.
Connection status ConnectionStatus
Queries the connection status of the Skype client.
IConversion Convert
Queries the conversion object.
IUser CurrentUser
Queries the current user object.
unicode CurrentUserHandle
Queries the Skypename of the current user.
IProfile CurrentUserProfile
Queries the user profile object.
Online status CurrentUserStatus
Queries/sets the online status of the current user.
tuple of IGroup CustomGroups
Queries the list of custom contact groups.
tuple of IFileTransfer FileTransfers
Queries all file transfers.
tuple of IUser FocusedContacts
Queries a list of contacts selected in the contacts list.
unicode FriendlyName
Sets a "friendly" name for an application.
tuple of IUser Friends
Queries the users in a contact list.
tuple of IGroup Groups
Queries the list of all contact groups.
tuple of IGroup HardwiredGroups
Queries the list of hardwired contact groups.
tuple of ICall MissedCalls
Queries a list of missed calls.
tuple of IChat MissedChats
Queries a list of missed chats.
IChatMessage MissedMessages
Queries a list of missed chat messages.
tuple of ISmsMessage MissedSmss
Requests a list of all missed SMS messages.
IVoicemail MissedVoicemails
Requests a list of missed voicemails.
bool Mute
Queries/sets the mute status of the Skype client.
unicode PredictiveDialerCountry
Returns predictive dialer coutry code.
int Protocol
Queries/sets the protocol version used by the Skype client.
tuple of IChat RecentChats
Queries a list of recent chats.
ISettings Settings
Queries the settings for Skype general parameters.
bool SilentMode
Returns/sets Skype silent mode status.
tuple of ISmsMessage Smss
Requests a list of all SMS messages.
int Timeout
Queries/sets the wait timeout value in milliseconds.
tuple of IUser UsersWaitingAuthorization
Queries the list of users waiting for authorization.
unicode Version
Queries the application version of the Skype client.
IVoicemail Voicemails
Queries a list of voicemails.
  OnSilentModeStatusChanged
  OnUserAuthorizationRequestReceived

Inherited from object: __class__

Method Details

__init__(self, Events=None, **Options)
(Constructor)

source code 

Initializes the object.

Parameters:
  • Events (object) - An optional object with event handlers. See EventHandlingBase for more information on events.
  • Options (kwargs) - Addtional options for the low-level API handler. For supported options, go to Skype4Py.API subpackage and select your platform.
Overrides: object.__init__

ApiSecurityContextEnabled(self, Context)

source code 

Queries if an API security context for Internet Explorer is enabled.

Parameters:
  • Context (unicode) - API security context to check.
Returns: bool
True if the API security for the given context is enabled, False elsewhere.

Warning: This functionality isn't supported by Skype4Py.

Application(self, Name)

source code 

Queries an application object.

Parameters:
  • Name (unicode) - Application name.
Returns: IApplication
The application object.

AsyncSearchUsers(self, Target)

source code 

Asynchronously searches for Skype users.

Parameters:
  • Target (unicode) - Search target (name or email address).
Returns: int
A search identifier. It will be passed along with the results to the ISkypeEvents.AsyncSearchUsersFinished event after the search is completed.

Attach(self, Protocol=5, Wait=True)

source code 

Establishes a connection to Skype.

Parameters:
  • Protocol (int) - Minimal Skype protocol version.
  • Wait (bool) - If set to False, blocks forever until the connection is established. Otherwise, timeouts after the Timeout.

Call(self, Id=0)

source code 

Queries a call object.

Parameters:
  • Id (int) - Call identifier.
Returns: ICall
Call object.

Calls(self, Target='')

source code 

Queries calls in call history.

Parameters:
  • Target (unicode) - Call target.
Returns: tuple of ICall
Call objects.

ChangeUserStatus(self, Val)

source code 

Changes the online status for the current user.

Parameters:

Note: This function waits until the online status changes. Alternatively, use the CurrentUserStatus property to perform an immediate change of status.

Chat(self, Name='')

source code 

Queries a chat object.

Parameters:
  • Name (unicode) - Chat name.
Returns: IChat
A chat object.

ClearCallHistory(self, Username='ALL', Type='ALL')

source code 

Clears the call history.

Parameters:
  • Username (unicode) - Skypename of the user. A special value of 'ALL' means that entries of all users should be removed.
  • Type (Call type) - Call type.

Command(self, Command, Reply=u'', Block=False, Timeout=30000, Id=-1)

source code 

Creates an API command object.

Parameters:
  • Command (unicode) - Command string.
  • Reply (unicode) - Expected reply. By default any reply is accepted (except errors which raise an ISkypeError exception).
  • Block (bool) - If set to True, SendCommand method waits for a response from Skype API before returning.
  • Timeout (int) - Timeout in milliseconds. Used if Block=True.
  • Id (int) - Command Id. The default (-1) means it will be assigned automatically as soon as the command is sent.
Returns: ICommand
A command object.

See Also: SendCommand

Conference(self, Id=0)

source code 

Queries a call conference object.

Parameters:
  • Id (int) - Conference Id.
Returns: IConference
A conference object.

CreateChatUsingBlob(self, Blob)

source code 

Returns existing or joins a new chat using given blob.

Parameters:
  • Blob (unicode) - A blob indentifying the chat.
Returns: IChat
A chat object

CreateChatWith(self, *Usernames)

source code 

Creates a chat with one or more users.

Parameters:
  • Usernames (unicode) - One or more strings with the Skypenames of the users.
Returns: IChat
A chat object

See Also: IChat.AddMembers

CreateGroup(self, GroupName)

source code 

Creates a custom contact group.

Parameters:
  • GroupName (unicode) - Group name.
Returns: IGroup
A group object.

See Also: DeleteGroup

CreateSms(self, MessageType, *TargetNumbers)

source code 

Creates an SMS message.

Parameters:
  • MessageType (SMS message type) - Message type.
  • TargetNumbers (unicode) - One or more target SMS numbers.
Returns: ISmsMessage
An sms message object.

DeleteGroup(self, GroupId)

source code 

Deletes a custom contact group.

Users in the contact group are moved to the All Contacts (hardwired) contact group.

Parameters:
  • GroupId (int) - Group identifier. Get it from IGroup.Id.

See Also: CreateGroup

EnableApiSecurityContext(self, Context)

source code 

Enables an API security context for Internet Explorer scripts.

Parameters:
  • Context (unicode) - combination of API security context values.

Warning: This functionality isn't supported by Skype4Py.

FindChatUsingBlob(self, Blob)

source code 

Returns existing chat using given blob.

Parameters:
  • Blob (unicode) - A blob indentifying the chat.
Returns: IChat
A chat object

Greeting(self, Username='')

source code 

Queries the greeting used as voicemail.

Parameters:
  • Username (unicode) - Skypename of the user.
Returns: IVoicemail
A voicemail object.

Message(self, Id=0)

source code 

Queries a chat message object.

Parameters:
  • Id (int) - Message Id.
Returns: IChatMessage
A chat message object.

Messages(self, Target='')

source code 

Queries chat messages which were sent/received by the user.

Parameters:
  • Target (unicode) - Message sender.
Returns: tuple of IChatMessage
Chat message objects.

PlaceCall(self, *Targets)

source code 

Places a call to a single user or creates a conference call.

Parameters:
  • Targets (unicode) - One or more call targets. If multiple targets are specified, a conference call is created. The call target can be a Skypename, phone number, or speed dial code.
Returns: ICall
A call object.

Privilege(self, Name)

source code 

Queries the Skype services (privileges) enabled for the Skype client.

Parameters:
  • Name (unicode) - Privilege name, currently one of 'SKYPEOUT', 'SKYPEIN', 'VOICEMAIL'.
Returns: bool
True if the priviledge is available, False otherwise.

Profile(self, Property, Set=None)

source code 

Queries/sets user profile properties.

Parameters:
  • Property (unicode) - Property name, currently one of 'PSTN_BALANCE', 'PSTN_BALANCE_CURRENCY', 'FULLNAME', 'BIRTHDAY', 'SEX', 'LANGUAGES', 'COUNTRY', 'PROVINCE', 'CITY', 'PHONE_HOME', 'PHONE_OFFICE', 'PHONE_MOBILE', 'HOMEPAGE', 'ABOUT'.
  • Set (unicode or None) - Value the property should be set to or None if the value should be queried.
Returns: unicode or None
Property value if Set=None, None otherwise.

Property(self, ObjectType, ObjectId, PropName, Set=None)

source code 

Queries/sets the properties of an object.

Parameters:
  • ObjectType (unicode) - Object type, currently one of 'USER', 'CALL', 'CHAT', 'CHATMESSAGE', 'VOICEMAIL'.
  • ObjectId (unicode) - Object Id, depends on the object type
  • PropName (unicode) - Name of the property you want to access.
  • Set (unicode or None) - Value the property should be set to or None if the value should be queried.
Returns: unicode or None
Property value if Set=None, None otherwise.

ResetCache(self)

source code 

Deletes all command cache entries.

This method clears the Skype4Py's internal command cache which means that all objects will forget their property values and querying them will trigger a code to get them from Skype client (and cache them again).

SearchForUsers(self, Target)

source code 

Searches for users.

Parameters:
  • Target (unicode) - Search target (name or email address).
Returns: tuple of IUser
Found users.

SendCommand(self, Command)

source code 

Sends an API command.

Parameters:
  • Command (ICommand) - Command to send. Use Command method to create a command.

SendMessage(self, Username, Text)

source code 

Sends a chat message.

Parameters:
  • Username (unicode) - Skypename of the user.
  • Text (unicode) - Body of the message.
Returns: IChatMessage
A chat message object.

SendSms(self, *TargetNumbers, **Properties)

source code 

Creates and sends an SMS message.

Parameters:
  • TargetNumbers (unicode) - One or more target SMS numbers.
  • Properties (kwargs) - Message properties. Properties available are same as ISmsMessage object properties.
Returns: ISmsMessage
An sms message object. The message is already sent at this point.

SendVoicemail(self, Username)

source code 

Sends a voicemail to a specified user.

Parameters:
  • Username (unicode) - Skypename of the user.
Returns: IVoicemail
A voicemail object.

User(self, Username='')

source code 

Queries a user object.

Parameters:
  • Username (unicode) - Skypename of the user.
Returns: IUser
A user object.

Variable(self, Name, Set=None)

source code 

Queries/sets Skype general parameters.

Parameters:
  • Name (unicode) - Variable name.
  • Set (unicode or None) - Value the variable should be set to or None if the value should be queried.
Returns: unicode or None
Variable value if Set=None, None otherwise.

Voicemail(self, Id)

source code 

Queries the voicemail object.

Parameters:
  • Id (int) - Voicemail Id.
Returns: IVoicemail
A voicemail object.

Instance Variable Details

OnApplicationConnecting

Event handler for ISkypeEvents.ApplicationConnecting event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnApplicationDatagram

Event handler for ISkypeEvents.ApplicationDatagram event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnApplicationReceiving

Event handler for ISkypeEvents.ApplicationReceiving event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnApplicationSending

Event handler for ISkypeEvents.ApplicationSending event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnApplicationStreams

Event handler for ISkypeEvents.ApplicationStreams event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnAsyncSearchUsersFinished

Event handler for ISkypeEvents.AsyncSearchUsersFinished event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnAttachmentStatus

Event handler for ISkypeEvents.AttachmentStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnAutoAway

Event handler for ISkypeEvents.AutoAway event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallDtmfReceived

Event handler for ISkypeEvents.CallDtmfReceived event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallHistory

Event handler for ISkypeEvents.CallHistory event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallInputStatusChanged

Event handler for ISkypeEvents.CallInputStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallSeenStatusChanged

Event handler for ISkypeEvents.CallSeenStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallStatus

Event handler for ISkypeEvents.CallStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallTransferStatusChanged

Event handler for ISkypeEvents.CallTransferStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallVideoReceiveStatusChanged

Event handler for ISkypeEvents.CallVideoReceiveStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallVideoSendStatusChanged

Event handler for ISkypeEvents.CallVideoSendStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCallVideoStatusChanged

Event handler for ISkypeEvents.CallVideoStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnChatMemberRoleChanged

Event handler for ISkypeEvents.ChatMemberRoleChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnChatMembersChanged

Event handler for ISkypeEvents.ChatMembersChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnChatWindowState

Event handler for ISkypeEvents.ChatWindowState event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnClientWindowState

Event handler for ISkypeEvents.ClientWindowState event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCommand

Event handler for ISkypeEvents.Command event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnConnectionStatus

Event handler for ISkypeEvents.ConnectionStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnContactsFocused

Event handler for ISkypeEvents.ContactsFocused event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnError

Event handler for ISkypeEvents.Error event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnFileTransferStatusChanged

Event handler for ISkypeEvents.FileTransferStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnGroupDeleted

Event handler for ISkypeEvents.GroupDeleted event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnGroupExpanded

Event handler for ISkypeEvents.GroupExpanded event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnGroupUsers

Event handler for ISkypeEvents.GroupUsers event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnGroupVisible

Event handler for ISkypeEvents.GroupVisible event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnMessageHistory

Event handler for ISkypeEvents.MessageHistory event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnMessageStatus

Event handler for ISkypeEvents.MessageStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnMute

Event handler for ISkypeEvents.Mute event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnNotify

Event handler for ISkypeEvents.Notify event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnOnlineStatus

Event handler for ISkypeEvents.OnlineStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnPluginEventClicked

Event handler for ISkypeEvents.PluginEventClicked event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnPluginMenuItemClicked

Event handler for ISkypeEvents.PluginMenuItemClicked event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnReply

Event handler for ISkypeEvents.Reply event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnSmsMessageStatusChanged

Event handler for ISkypeEvents.SmsMessageStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnSmsTargetStatusChanged

Event handler for ISkypeEvents.SmsTargetStatusChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnUserMood

Event handler for ISkypeEvents.UserMood event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnUserStatus

Event handler for ISkypeEvents.UserStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnVoicemailStatus

Event handler for ISkypeEvents.VoicemailStatus event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnWallpaperChanged

Event handler for ISkypeEvents.WallpaperChanged event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

Property Details

ActiveCalls

Queries a list of active calls.

Get Method:
_GetActiveCalls(self)
Type:
tuple of ICall

ActiveChats

Queries a list of active chats.

Get Method:
_GetActiveChats(self)
Type:
tuple of IChat

ActiveFileTransfers

Queries currently active file transfers.

Get Method:
_GetActiveFileTransfers(self)
Type:
tuple of IFileTransfer

ApiDebugLevel

Queries/sets the debug level of the underlying API. Currently there are only two levels, 0 which means no debug information and 1 which means that the commands sent to / received from the Skype client are printed to the sys.stderr.

Get Method:
_GetApiDebugLevel(self)
Set Method:
_SetApiDebugLevel(self, value)
Type:
int

ApiWrapperVersion

Returns Skype4Py version.

Get Method:
_GetApiWrapperVersion(self)
Type:
unicode

AttachmentStatus

Queries the attachment status of the Skype client.

Get Method:
_GetAttachmentStatus(self)
Type:
Attachment status

BookmarkedChats

Queries a list of bookmarked chats.

Get Method:
_GetBookmarkedChats(self)
Type:
tuple of IChat

Cache

Queries/sets the status of internal cache. The internal API cache is used to cache Skype object properties and global parameters.

Get Method:
_GetCache(self)
Set Method:
_SetCache(self, value)
Type:
bool

Chats

Queries a list of chats.

Get Method:
_GetChats(self)
Type:
tuple of IChat

Client

Queries the user interface control object.

Get Method:
_GetClient(self)
Type:
IClient

CommandId

Queries/sets the status of automatic command identifiers.

Type: bool Note: Currently it is always True.

Get Method:
_GetCommandId(self)
Set Method:
_SetCommandId(self, value)
Type:
bool

Conferences

Queries a list of call conferences.

Get Method:
_GetConferences(self)
Type:
tuple of IConference

ConnectionStatus

Queries the connection status of the Skype client.

Get Method:
_GetConnectionStatus(self)
Type:
Connection status

Convert

Queries the conversion object.

Get Method:
_GetConvert(self)
Type:
IConversion

CurrentUser

Queries the current user object.

Get Method:
_GetCurrentUser(self)
Type:
IUser

CurrentUserHandle

Queries the Skypename of the current user.

Get Method:
_GetCurrentUserHandle(self)
Type:
unicode

CurrentUserProfile

Queries the user profile object.

Get Method:
_GetCurrentUserProfile(self)
Type:
IProfile

CurrentUserStatus

Queries/sets the online status of the current user.

Get Method:
_GetCurrentUserStatus(self)
Set Method:
_SetCurrentUserStatus(self, value)
Type:
Online status

CustomGroups

Queries the list of custom contact groups. Custom groups are contact groups defined by the user.

Get Method:
_GetCustomGroups(self)
Type:
tuple of IGroup

FileTransfers

Queries all file transfers.

Get Method:
_GetFileTransfers(self)
Type:
tuple of IFileTransfer

FocusedContacts

Queries a list of contacts selected in the contacts list.

Get Method:
_GetFocusedContacts(self)
Type:
tuple of IUser

FriendlyName

Sets a "friendly" name for an application.

Set Method:
_SetFriendlyName(self, FriendlyName)
Type:
unicode

Friends

Queries the users in a contact list.

Get Method:
_GetFriends(self)
Type:
tuple of IUser

Groups

Queries the list of all contact groups.

Get Method:
_GetGroups(self)
Type:
tuple of IGroup

HardwiredGroups

Queries the list of hardwired contact groups. Hardwired groups are "smart" contact groups, defined by Skype, that cannot be removed.

Get Method:
_GetHardwiredGroups(self)
Type:
tuple of IGroup

MissedCalls

Queries a list of missed calls.

Get Method:
_GetMissedCalls(self)
Type:
tuple of ICall

MissedChats

Queries a list of missed chats.

Get Method:
_GetMissedChats(self)
Type:
tuple of IChat

MissedMessages

Queries a list of missed chat messages.

Get Method:
_GetMissedMessages(self)
Type:
IChatMessage

MissedSmss

Requests a list of all missed SMS messages.

Get Method:
_GetMissedSmss(self)
Type:
tuple of ISmsMessage

MissedVoicemails

Requests a list of missed voicemails.

Get Method:
_GetMissedVoicemails(self)
Type:
IVoicemail

Mute

Queries/sets the mute status of the Skype client.

Type: bool Note: This value can be set only when there is an active call.

Get Method:
_GetMute(self)
Set Method:
_SetMute(self, value)
Type:
bool

PredictiveDialerCountry

Returns predictive dialer coutry code.

Get Method:
_GetPredictiveDialerCountry(self)
Type:
unicode

Protocol

Queries/sets the protocol version used by the Skype client.

Get Method:
_GetProtocol(self)
Set Method:
_SetProtocol(self, value)
Type:
int

RecentChats

Queries a list of recent chats.

Get Method:
_GetRecentChats(self)
Type:
tuple of IChat

Settings

Queries the settings for Skype general parameters.

Get Method:
_GetSettings(self)
Type:
ISettings

SilentMode

Returns/sets Skype silent mode status.

Get Method:
_GetSilentMode(self)
Set Method:
_SetSilentMode(self, value)
Type:
bool

Smss

Requests a list of all SMS messages.

Get Method:
_GetSmss(self)
Type:
tuple of ISmsMessage

Timeout

Queries/sets the wait timeout value in milliseconds. This timeout value applies to every command sent to the Skype API. If a response is not received during the timeout period, an ISkypeAPIError exception is raised.

Get Method:
_GetTimeout(self)
Set Method:
_SetTimeout(self, value)
Type:
int

UsersWaitingAuthorization

Queries the list of users waiting for authorization.

Get Method:
_GetUsersWaitingAuthorization(self)
Type:
tuple of IUser

Version

Queries the application version of the Skype client.

Get Method:
_GetVersion(self)
Type:
unicode

Voicemails

Queries a list of voicemails.

Get Method:
_GetVoicemails(self)
Type:
IVoicemail

OnSilentModeStatusChanged

Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnUserAuthorizationRequestReceived

Get Method:
unreachable(self)
Set Method:
unreachable(self, value)