Home | Trees | Indices | Help |
|
---|
|
object --+ | utils.EventHandlingBase --+ | Skype
The main class which you have to instantiate to get access to the Skype client running currently in the background.
You should access this class using the alias at the package level:
import Skype4Py skype = Skype4Py.Skype()
Read the constructor (Skype.__init__) documentation for a list of accepted arguments.
This class provides events.
The events names and their arguments lists can be found in the SkypeEvents class in this module.
The use of events is explained in the EventHandlingBase class which is a superclass of this class.
Instance Methods | |||
|
|||
|
|||
bool |
|
||
application.Application |
|
||
int |
|
||
|
|||
call.Call |
|
||
CallCollection |
|
||
|
|||
chat.Chat |
|
||
|
|||
|
|||
|
|||
Command |
|
||
Conference |
|
||
chat.Chat |
|
||
Chat |
|
||
Group |
|
||
SmsMessage |
|
||
|
|||
|
|||
chat.Chat |
|
||
Voicemail |
|
||
ChatMessage |
|
||
ChatMessageCollection |
|
||
call.Call |
|
||
bool |
|
||
unicode or None |
|
||
unicode or None |
|
||
|
|||
UserCollection |
|
||
|
|||
ChatMessage |
|
||
SmsMessage |
|
||
|
|||
user.User |
|
||
unicode or None |
|
||
Voicemail |
|
||
Inherited from Inherited from |
Properties | |
CallCollection |
ActiveCalls Queries a list of active calls. |
ChatCollection |
ActiveChats Queries a list of active chats. |
FileTransferCollection |
ActiveFileTransfers Queries currently active file transfers. |
str |
ApiWrapperVersion Returns Skype4Py version. |
enums.apiAttach* |
AttachmentStatus Queries the attachment status of the Skype client. |
ChatCollection |
BookmarkedChats Queries a list of bookmarked chats. |
bool |
Cache Queries/sets the status of internal cache. |
ChatCollection |
Chats Queries a list of chats. |
Client |
Client Queries the user interface control object. |
bool |
CommandId Queries/sets the status of automatic command identifiers. |
ConferenceCollection |
Conferences Queries a list of call conferences. |
enums.con* |
ConnectionStatus Queries the connection status of the Skype client. |
Conversion |
Convert Queries the conversion object. |
user.User |
CurrentUser Queries the current user object. |
str |
CurrentUserHandle Queries the Skypename of the current user. |
Profile |
CurrentUserProfile Queries the user profile object. |
enums.ols* |
CurrentUserStatus Queries/sets the online status of the current user. |
GroupCollection |
CustomGroups Queries the list of custom contact groups. |
FileTransferCollection |
FileTransfers Queries all file transfers. |
UserCollection |
FocusedContacts Queries a list of contacts selected in the contacts list. |
unicode |
FriendlyName Queries/sets a "friendly" name for an application. |
UserCollection |
Friends Queries the users in a contact list. |
GroupCollection |
Groups Queries the list of all contact groups. |
GroupCollection |
HardwiredGroups Queries the list of hardwired contact groups. |
CallCollection |
MissedCalls Queries a list of missed calls. |
ChatCollection |
MissedChats Queries a list of missed chats. |
ChatMessageCollection |
MissedMessages Queries a list of missed chat messages. |
SmsMessageCollection |
MissedSmss Requests a list of all missed SMS messages. |
VoicemailCollection |
MissedVoicemails Requests a list of missed voicemails. |
bool |
Mute Queries/sets the mute status of the Skype client. |
str |
PredictiveDialerCountry Returns predictive dialler country as an ISO code. |
int |
Protocol Queries/sets the protocol version used by the Skype client. |
ChatCollection |
RecentChats Queries a list of recent chats. |
Settings |
Settings Queries the settings for Skype general parameters. |
bool |
SilentMode Returns/sets Skype silent mode status. |
SmsMessageCollection |
Smss Requests a list of all SMS messages. |
float, int or long |
Timeout Queries/sets the wait timeout value. |
UserCollection |
UsersWaitingAuthorization Queries the list of users waiting for authorization. |
str |
Version Queries the application version of the Skype client. |
VoicemailCollection |
Voicemails Queries a list of voicemails. |
OnApplicationConnecting | |
OnApplicationDatagram | |
OnApplicationReceiving | |
OnApplicationSending | |
OnApplicationStreams | |
OnAsyncSearchUsersFinished | |
OnAttachmentStatus | |
OnAutoAway | |
OnCallDtmfReceived | |
OnCallHistory | |
OnCallInputStatusChanged | |
OnCallSeenStatusChanged | |
OnCallStatus | |
OnCallTransferStatusChanged | |
OnCallVideoReceiveStatusChanged | |
OnCallVideoSendStatusChanged | |
OnCallVideoStatusChanged | |
OnChatMemberRoleChanged | |
OnChatMembersChanged | |
OnChatWindowState | |
OnClientWindowState | |
OnCommand | |
OnConnectionStatus | |
OnContactsFocused | |
OnError | |
OnFileTransferStatusChanged | |
OnGroupDeleted | |
OnGroupExpanded | |
OnGroupUsers | |
OnGroupVisible | |
OnMessageHistory | |
OnMessageStatus | |
OnMute | |
OnNotify | |
OnOnlineStatus | |
OnPluginEventClicked | |
OnPluginMenuItemClicked | |
OnReply | |
OnSilentModeStatusChanged | |
OnSmsMessageStatusChanged | |
OnSmsTargetStatusChanged | |
OnUserAuthorizationRequestReceived | |
OnUserMood | |
OnUserStatus | |
OnVoicemailStatus | |
OnWallpaperChanged | |
Inherited from |
Method Details |
|
Warning: This functionality isn't supported by Skype4Py. |
|
|
|
|
|
Note: This function waits until the online status changes. Alternatively, use the CurrentUserStatus property to perform an immediate change of status. |
|
|
See Also: SendCommand |
|
|
See Also: Chat.AddMembers |
See Also: DeleteGroup |
|
Deletes a custom contact group. Users in the contact group are moved to the All Contacts (hardwired) contact group.
See Also: CreateGroup |
Warning: This functionality isn't supported by Skype4Py. |
|
|
|
|
|
|
|
|
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). |
|
|
|
|
Note: Should return a Voicemail object. This is not implemented yet. |
|
|
|
Property Details |
ActiveCallsQueries a list of active calls.
|
ActiveChatsQueries a list of active chats.
|
ActiveFileTransfersQueries currently active file transfers.
|
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. |
ChatsQueries a list of chats.
|
ClientQueries the user interface control object.
|
CommandIdQueries/sets the status of automatic command identifiers.
Note: Currently the only supported value is 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.
|
FriendlyNameQueries/sets 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 dialler country as an ISO 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. This timeout value applies to every command sent to the Skype API and to attachment requests (see Attach). If a response is not received during the timeout period, an SkypeAPIError exception is raised. The units depend on the type. For float it is the number of seconds (or fractions thereof), for int or long it is the number of milliseconds. Floats are commonly used in Python modules to express timeouts (time.sleep() for example). Milliseconds are supported because that's what the Skype4COM library uses. Skype4Py support for real float timeouts was introduced in version 1.0.31.1. The default value is 30000 milliseconds (int).
|
UsersWaitingAuthorizationQueries the list of users waiting for authorization.
|
VersionQueries the application version of the Skype client.
|
VoicemailsQueries a list of voicemails.
|
OnApplicationConnecting
|
OnApplicationDatagram
|
OnApplicationReceiving
|
OnApplicationSending
|
OnApplicationStreams
|
OnAsyncSearchUsersFinished
|
OnAttachmentStatus
|
OnAutoAway
|
OnCallDtmfReceived
|
OnCallHistory
|
OnCallInputStatusChanged
|
OnCallSeenStatusChanged
|
OnCallStatus
|
OnCallTransferStatusChanged
|
OnCallVideoReceiveStatusChanged
|
OnCallVideoSendStatusChanged
|
OnCallVideoStatusChanged
|
OnChatMemberRoleChanged
|
OnChatMembersChanged
|
OnChatWindowState
|
OnClientWindowState
|
OnCommand
|
OnConnectionStatus
|
OnContactsFocused
|
OnError
|
OnFileTransferStatusChanged
|
OnGroupDeleted
|
OnGroupExpanded
|
OnGroupUsers
|
OnGroupVisible
|
OnMessageHistory
|
OnMessageStatus
|
OnMute
|
OnNotify
|
OnOnlineStatus
|
OnPluginEventClicked
|
OnPluginMenuItemClicked
|
OnReply
|
OnSilentModeStatusChanged
|
OnSmsMessageStatusChanged
|
OnSmsTargetStatusChanged
|
OnUserAuthorizationRequestReceived
|
OnUserMood
|
OnUserStatus
|
OnVoicemailStatus
|
OnWallpaperChanged
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Sat Sep 26 16:13:06 2009 | http://epydoc.sourceforge.net |