Home | Trees | Indices | Help |
|
---|
|
object --+ | utils.EventHandlingBase --+ | ISkype
The main class which you have to instatinate to get access to Skype client.
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.
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 | |||
|
|||
|
|||
bool |
|
||
IApplication |
|
||
int |
|
||
|
|||
ICall |
|
||
tuple of ICall |
|
||
|
|||
IChat |
|
||
|
|||
|
|||
|
|||
ICommand |
|
||
IConference |
|
||
IChat |
|
||
IChat |
|
||
IGroup |
|
||
ISmsMessage |
|
||
|
|||
|
|||
IChat |
|
||
IVoicemail |
|
||
IChatMessage |
|
||
tuple of IChatMessage |
|
||
ICall |
|
||
bool |
|
||
unicode or None |
|
||
unicode or None |
|
||
|
|||
tuple of IUser |
|
||
|
|||
IChatMessage |
|
||
ISmsMessage |
|
||
IVoicemail |
|
||
IUser |
|
||
unicode or None |
|
||
IVoicemail |
|
||
Inherited from Inherited from |
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 |
Method Details |
Initializes the object.
|
Queries if an API security context for Internet Explorer is enabled.
Warning: This functionality isn't supported by Skype4Py. |
Queries an application object.
|
Asynchronously searches for Skype users.
|
Establishes a connection to Skype.
|
Queries a call object.
|
Queries calls in call history.
|
Changes the online status for the current user.
Note: This function waits until the online status changes. Alternatively, use the CurrentUserStatus property to perform an immediate change of status. |
Queries a chat object.
|
Clears the call history.
|
Creates an API command object.
See Also: SendCommand |
Queries a call conference object.
|
Returns existing or joins a new chat using given blob.
|
Creates a chat with one or more users.
See Also: IChat.AddMembers |
Creates a custom contact group.
See Also: DeleteGroup |
Creates an SMS message.
|
Deletes a custom contact group. Users in the contact group are moved to the All Contacts (hardwired) contact group.
See Also: CreateGroup |
Enables an API security context for Internet Explorer scripts.
Warning: This functionality isn't supported by Skype4Py. |
Returns existing chat using given blob.
|
Queries the greeting used as voicemail.
|
Queries a chat message object.
|
Queries chat messages which were sent/received by the user.
|
Places a call to a single user or creates a conference call.
|
Queries the Skype services (privileges) enabled for the Skype client.
|
Queries/sets user profile properties.
|
Queries/sets the properties of an object.
|
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). |
Searches for users.
|
Sends an API command. |
Sends a chat message.
|
Creates and sends an SMS message.
|
Sends a voicemail to a specified user.
|
Queries a user object.
|
Queries/sets Skype general parameters.
|
Queries the voicemail object.
|
Instance Variable Details |
OnApplicationConnectingEvent handler for ISkypeEvents.ApplicationConnecting event. See EventHandlingBase for more information on events.
|
OnApplicationDatagramEvent handler for ISkypeEvents.ApplicationDatagram event. See EventHandlingBase for more information on events.
|
OnApplicationReceivingEvent handler for ISkypeEvents.ApplicationReceiving event. See EventHandlingBase for more information on events.
|
OnApplicationSendingEvent handler for ISkypeEvents.ApplicationSending event. See EventHandlingBase for more information on events.
|
OnApplicationStreamsEvent handler for ISkypeEvents.ApplicationStreams event. See EventHandlingBase for more information on events.
|
OnAsyncSearchUsersFinishedEvent handler for ISkypeEvents.AsyncSearchUsersFinished event. See EventHandlingBase for more information on events.
|
OnAttachmentStatusEvent handler for ISkypeEvents.AttachmentStatus event. See EventHandlingBase for more information on events.
|
OnAutoAwayEvent handler for ISkypeEvents.AutoAway event. See EventHandlingBase for more information on events.
|
OnCallDtmfReceivedEvent handler for ISkypeEvents.CallDtmfReceived event. See EventHandlingBase for more information on events.
|
OnCallHistoryEvent handler for ISkypeEvents.CallHistory event. See EventHandlingBase for more information on events.
|
OnCallInputStatusChangedEvent handler for ISkypeEvents.CallInputStatusChanged event. See EventHandlingBase for more information on events.
|
OnCallSeenStatusChangedEvent handler for ISkypeEvents.CallSeenStatusChanged event. See EventHandlingBase for more information on events.
|
OnCallStatusEvent handler for ISkypeEvents.CallStatus event. See EventHandlingBase for more information on events.
|
OnCallTransferStatusChangedEvent handler for ISkypeEvents.CallTransferStatusChanged event. See EventHandlingBase for more information on events.
|
OnCallVideoReceiveStatusChangedEvent handler for ISkypeEvents.CallVideoReceiveStatusChanged event. See EventHandlingBase for more information on events.
|
OnCallVideoSendStatusChangedEvent handler for ISkypeEvents.CallVideoSendStatusChanged event. See EventHandlingBase for more information on events.
|
OnCallVideoStatusChangedEvent handler for ISkypeEvents.CallVideoStatusChanged event. See EventHandlingBase for more information on events.
|
OnChatMemberRoleChangedEvent handler for ISkypeEvents.ChatMemberRoleChanged event. See EventHandlingBase for more information on events.
|
OnChatMembersChangedEvent handler for ISkypeEvents.ChatMembersChanged event. See EventHandlingBase for more information on events.
|
OnChatWindowStateEvent handler for ISkypeEvents.ChatWindowState event. See EventHandlingBase for more information on events.
|
OnClientWindowStateEvent handler for ISkypeEvents.ClientWindowState event. See EventHandlingBase for more information on events.
|
OnCommandEvent handler for ISkypeEvents.Command event. See EventHandlingBase for more information on events.
|
OnConnectionStatusEvent handler for ISkypeEvents.ConnectionStatus event. See EventHandlingBase for more information on events.
|
OnContactsFocusedEvent handler for ISkypeEvents.ContactsFocused event. See EventHandlingBase for more information on events.
|
OnErrorEvent handler for ISkypeEvents.Error event. See EventHandlingBase for more information on events.
|
OnFileTransferStatusChangedEvent handler for ISkypeEvents.FileTransferStatusChanged event. See EventHandlingBase for more information on events.
|
OnGroupDeletedEvent handler for ISkypeEvents.GroupDeleted event. See EventHandlingBase for more information on events.
|
OnGroupExpandedEvent handler for ISkypeEvents.GroupExpanded event. See EventHandlingBase for more information on events.
|
OnGroupUsersEvent handler for ISkypeEvents.GroupUsers event. See EventHandlingBase for more information on events.
|
OnGroupVisibleEvent handler for ISkypeEvents.GroupVisible event. See EventHandlingBase for more information on events.
|
OnMessageHistoryEvent handler for ISkypeEvents.MessageHistory event. See EventHandlingBase for more information on events.
|
OnMessageStatusEvent handler for ISkypeEvents.MessageStatus event. See EventHandlingBase for more information on events.
|
OnMuteEvent handler for ISkypeEvents.Mute event. See EventHandlingBase for more information on events.
|
OnNotifyEvent handler for ISkypeEvents.Notify event. See EventHandlingBase for more information on events.
|
OnOnlineStatusEvent handler for ISkypeEvents.OnlineStatus event. See EventHandlingBase for more information on events.
|
OnPluginEventClickedEvent handler for ISkypeEvents.PluginEventClicked event. See EventHandlingBase for more information on events.
|
OnPluginMenuItemClickedEvent handler for ISkypeEvents.PluginMenuItemClicked event. See EventHandlingBase for more information on events.
|
OnReplyEvent handler for ISkypeEvents.Reply event. See EventHandlingBase for more information on events.
|
OnSmsMessageStatusChangedEvent handler for ISkypeEvents.SmsMessageStatusChanged event. See EventHandlingBase for more information on events.
|
OnSmsTargetStatusChangedEvent handler for ISkypeEvents.SmsTargetStatusChanged event. See EventHandlingBase for more information on events.
|
OnUserMoodEvent handler for ISkypeEvents.UserMood event. See EventHandlingBase for more information on events.
|
OnUserStatusEvent handler for ISkypeEvents.UserStatus event. See EventHandlingBase for more information on events.
|
OnVoicemailStatusEvent handler for ISkypeEvents.VoicemailStatus event. See EventHandlingBase for more information on events.
|
OnWallpaperChangedEvent handler for ISkypeEvents.WallpaperChanged event. See EventHandlingBase for more information on events.
|
Property Details |
ActiveCallsQueries a list of active calls.
|
ActiveChatsQueries a list of active chats.
|
ActiveFileTransfersQueries currently active file transfers.
|
ApiDebugLevelQueries/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.
|
ApiWrapperVersionReturns Skype4Py version.
|
AttachmentStatusQueries the attachment status of the Skype client.
|
BookmarkedChatsQueries a list of bookmarked chats.
|
CacheQueries/sets the status of internal cache. The internal API cache is used to cache Skype object properties and global parameters. |
ClientQueries the user interface control object.
|
CommandIdQueries/sets the status of automatic command identifiers. Type: bool Note: Currently it is always True.
|
ConferencesQueries a list of call conferences.
|
ConnectionStatusQueries the connection status of the Skype client.
|
ConvertQueries the conversion object.
|
CurrentUserQueries the current user object.
|
CurrentUserHandleQueries the Skypename of the current user.
|
CurrentUserProfileQueries the user profile object.
|
CurrentUserStatusQueries/sets the online status of the current user.
|
CustomGroupsQueries the list of custom contact groups. Custom groups are contact groups defined by the user.
|
FileTransfersQueries all file transfers.
|
FocusedContactsQueries a list of contacts selected in the contacts list.
|
FriendlyNameSets a "friendly" name for an application.
|
FriendsQueries the users in a contact list.
|
GroupsQueries the list of all contact groups.
|
HardwiredGroupsQueries the list of hardwired contact groups. Hardwired groups are "smart" contact groups, defined by Skype, that cannot be removed.
|
MissedCallsQueries a list of missed calls.
|
MissedChatsQueries a list of missed chats.
|
MissedMessagesQueries a list of missed chat messages.
|
MissedSmssRequests a list of all missed SMS messages.
|
MissedVoicemailsRequests a list of missed voicemails.
|
MuteQueries/sets the mute status of the Skype client. Type: bool Note: This value can be set only when there is an active call. |
PredictiveDialerCountryReturns predictive dialer coutry code.
|
ProtocolQueries/sets the protocol version used by the Skype client.
|
RecentChatsQueries a list of recent chats.
|
SettingsQueries the settings for Skype general parameters.
|
SilentModeReturns/sets Skype silent mode status.
|
SmssRequests a list of all SMS messages.
|
TimeoutQueries/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.
|
UsersWaitingAuthorizationQueries the list of users waiting for authorization.
|
VersionQueries the application version of the Skype client.
|
VoicemailsQueries a list of voicemails.
|
OnSilentModeStatusChanged
|
OnUserAuthorizationRequestReceived
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Wed Nov 05 14:55:00 2008 | http://epydoc.sourceforge.net |