Home       Trees       Indices       Help   
Skype4Py
Package Skype4Py :: Module skype :: Class SkypeEvents
[frames] | no frames]

Class SkypeEvents

source code

object --+
         |
        SkypeEvents

Events defined in Skype.

See EventHandlingBase for more information on events.

Instance Methods
 
ApplicationConnecting(self, App, Users)
This event is triggered when list of users connecting to an application changes.		 source code
 
ApplicationDatagram(self, App, Stream, Text)
This event is caused by the arrival of an application datagram.		 source code
 
ApplicationReceiving(self, App, Streams)
This event is triggered when list of application receiving streams changes.		 source code
 
ApplicationSending(self, App, Streams)
This event is triggered when list of application sending streams changes.		 source code
 
ApplicationStreams(self, App, Streams)
This event is triggered when list of application streams changes.		 source code
 
AsyncSearchUsersFinished(self, Cookie, Users)
This event occurs when an asynchronous search is completed.		 source code
 
AttachmentStatus(self, Status)
This event is caused by a change in the status of an attachment to the Skype API.		 source code
 
AutoAway(self, Automatic)
This event is caused by a change of auto away status.		 source code
 
CallDtmfReceived(self, Call, Code)
This event is caused by a call DTMF event.		 source code
 
CallHistory(self)
This event is caused by a change in call history.		 source code
 
CallInputStatusChanged(self, Call, Active)
This event is caused by a change in the Call voice input status change.		 source code
 
CallSeenStatusChanged(self, Call, Seen)
This event occurs when the seen status of a call changes.		 source code
 
CallStatus(self, Call, Status)
This event is caused by a change in call status.		 source code
 
CallTransferStatusChanged(self, Call, Status)
This event occurs when a call transfer status changes.		 source code
 
CallVideoReceiveStatusChanged(self, Call, Status)
This event occurs when a call video receive status changes.		 source code
 
CallVideoSendStatusChanged(self, Call, Status)
This event occurs when a call video send status changes.		 source code
 
CallVideoStatusChanged(self, Call, Status)
This event occurs when a call video status changes.		 source code
 
ChatMemberRoleChanged(self, Member, Role)
This event occurs when a chat member role changes.		 source code
 
ChatMembersChanged(self, Chat, Members)
This event occurs when a list of chat members change.		 source code
 
ChatWindowState(self, Chat, State)
This event occurs when chat window is opened or closed.		 source code
 
ClientWindowState(self, State)
This event occurs when the state of the client window changes.		 source code
 
Command(self, command)
This event is triggered when a command is sent to the Skype API.		 source code
 
ConnectionStatus(self, Status)
This event is caused by a connection status change.		 source code
 
ContactsFocused(self, Username)
This event is caused by a change in contacts focus.		 source code
 
Error(self, command, Number, Description)
This event is triggered when an error occurs during execution of an API command.		 source code
 
FileTransferStatusChanged(self, Transfer, Status)
This event occurs when a file transfer status changes.		 source code
 
GroupDeleted(self, GroupId)
This event is caused by a user deleting a custom contact group.		 source code
 
GroupExpanded(self, Group, Expanded)
This event is caused by a user expanding or collapsing a group in the contacts tab.		 source code
 
GroupUsers(self, Group, Count)
This event is caused by a change in a contact group members.		 source code
 
GroupVisible(self, Group, Visible)
This event is caused by a user hiding/showing a group in the contacts tab.		 source code
 
MessageHistory(self, Username)
This event is caused by a change in message history.		 source code
 
MessageStatus(self, Message, Status)
This event is caused by a change in chat message status.		 source code
 
Mute(self, Mute)
This event is caused by a change in mute status.		 source code
 
Notify(self, Notification)
This event is triggered whenever Skype client sends a notification.		 source code
 
OnlineStatus(self, User, Status)
This event is caused by a change in the online status of a user.		 source code
 
PluginEventClicked(self, Event)
This event occurs when a user clicks on a plug-in event.		 source code
 
PluginMenuItemClicked(self, MenuItem, Users, PluginContext, ContextId)
This event occurs when a user clicks on a plug-in menu item.		 source code
 
Reply(self, command)
This event is triggered when the API replies to a command object.		 source code
 
SilentModeStatusChanged(self, Silent)
This event occurs when a silent mode is switched off.		 source code
 
SmsMessageStatusChanged(self, Message, Status)
This event is caused by a change in the SMS message status.		 source code
 
SmsTargetStatusChanged(self, Target, Status)
This event is caused by a change in the SMS target status.		 source code
 
UserAuthorizationRequestReceived(self, User)
This event occurs when user sends you an authorization request.		 source code
 
UserMood(self, User, MoodText)
This event is caused by a change in the mood text of the user.		 source code
 
UserStatus(self, Status)
This event is caused by a user status change.		 source code
 
VoicemailStatus(self, Mail, Status)
This event is caused by a change in voicemail status.		 source code
 
WallpaperChanged(self, Path)
This event occurs when client wallpaper changes.		 source code

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

Properties

Inherited from object: __class__

Method Details

ApplicationConnecting(self, App, Users)

source code 
This event is triggered when list of users connecting to an application changes.
Parameters:

ApplicationDatagram(self, App, Stream, Text)

source code 
This event is caused by the arrival of an application datagram.
Parameters:
  • App (Application) - Application object.
  • Stream (ApplicationStream) - Application stream that received the datagram.
  • Text (unicode) - The datagram text.

ApplicationReceiving(self, App, Streams)

source code 
This event is triggered when list of application receiving streams changes.
Parameters:

ApplicationSending(self, App, Streams)

source code 
This event is triggered when list of application sending streams changes.
Parameters:

ApplicationStreams(self, App, Streams)

source code 
This event is triggered when list of application streams changes.
Parameters:

AsyncSearchUsersFinished(self, Cookie, Users)

source code 
This event occurs when an asynchronous search is completed.
Parameters:

See Also: Skype.AsyncSearchUsers

AttachmentStatus(self, Status)

source code 
This event is caused by a change in the status of an attachment to the Skype API.
Parameters:
  • Status (enums.apiAttach*) - New attachment status.

AutoAway(self, Automatic)

source code 
This event is caused by a change of auto away status.
Parameters:
  • Automatic (bool) - New auto away status.

CallDtmfReceived(self, Call, Code)

source code 
This event is caused by a call DTMF event.
Parameters:
  • Call (Call) - Call object.
  • Code (str) - Received DTMF code.

CallInputStatusChanged(self, Call, Active)

source code 
This event is caused by a change in the Call voice input status change.
Parameters:
  • Call (Call) - Call object.
  • Active (bool) - New voice input status (active when True).

CallSeenStatusChanged(self, Call, Seen)

source code 
This event occurs when the seen status of a call changes.
Parameters:
  • Call (Call) - Call object.
  • Seen (bool) - True if call was seen.

See Also: Call.Seen

CallStatus(self, Call, Status)

source code 
This event is caused by a change in call status.
Parameters:
  • Call (Call) - Call object.
  • Status (enums.cls*) - New status of the call.

CallTransferStatusChanged(self, Call, Status)

source code 
This event occurs when a call transfer status changes.
Parameters:
  • Call (Call) - Call object.
  • Status (enums.cls*) - New status of the call transfer.

CallVideoReceiveStatusChanged(self, Call, Status)

source code 
This event occurs when a call video receive status changes.
Parameters:
  • Call (Call) - Call object.
  • Status (enums.vss*) - New video receive status of the call.

CallVideoSendStatusChanged(self, Call, Status)

source code 
This event occurs when a call video send status changes.
Parameters:
  • Call (Call) - Call object.
  • Status (enums.vss*) - New video send status of the call.

CallVideoStatusChanged(self, Call, Status)

source code 
This event occurs when a call video status changes.
Parameters:
  • Call (Call) - Call object.
  • Status (enums.cvs*) - New video status of the call.

ChatMemberRoleChanged(self, Member, Role)

source code 
This event occurs when a chat member role changes.
Parameters:
  • Member (ChatMember) - Chat member object.
  • Role (enums.chatMemberRole*) - New member role.

ChatMembersChanged(self, Chat, Members)

source code 
This event occurs when a list of chat members change.
Parameters:

ChatWindowState(self, Chat, State)

source code 
This event occurs when chat window is opened or closed.
Parameters:
  • Chat (Chat) - Chat object.
  • State (bool) - True if the window was opened or False if closed.

ClientWindowState(self, State)

source code 
This event occurs when the state of the client window changes.
Parameters:
  • State (enums.wnd*) - New window state.

Command(self, command)

source code 
This event is triggered when a command is sent to the Skype API.
Parameters:
  • command (Command) - Command object.

ConnectionStatus(self, Status)

source code 
This event is caused by a connection status change.
Parameters:
  • Status (enums.con*) - New connection status.

ContactsFocused(self, Username)

source code 
This event is caused by a change in contacts focus.
Parameters:
  • Username (str) - Name of the user that was focused or empty string if focus was lost.

Error(self, command, Number, Description)

source code 
This event is triggered when an error occurs during execution of an API command.
Parameters:
  • command (Command) - Command object that caused the error.
  • Number (int) - Error number returned by the Skype API.
  • Description (unicode) - Description of the error.

FileTransferStatusChanged(self, Transfer, Status)

source code 
This event occurs when a file transfer status changes.
Parameters:
  • Transfer (FileTransfer) - File transfer object.
  • Status (enums.fileTransferStatus*) - New status of the file transfer.

GroupDeleted(self, GroupId)

source code 
This event is caused by a user deleting a custom contact group.
Parameters:
  • GroupId (int) - Id of the deleted group.

GroupExpanded(self, Group, Expanded)

source code 
This event is caused by a user expanding or collapsing a group in the contacts tab.
Parameters:
  • Group (Group) - Group object.
  • Expanded (bool) - Tells if the group is expanded (True) or collapsed (False).

GroupUsers(self, Group, Count)

source code 
This event is caused by a change in a contact group members.
Parameters:
  • Group (Group) - Group object.
  • Count (int) - Number of group members.

Note: This event is different from its Skype4COM equivalent in that the second parameter is number of users instead of UserCollection object. This object may be obtained using Group.Users property.

GroupVisible(self, Group, Visible)

source code 
This event is caused by a user hiding/showing a group in the contacts tab.
Parameters:
  • Group (Group) - Group object.
  • Visible (bool) - Tells if the group is visible or not.

MessageHistory(self, Username)

source code 
This event is caused by a change in message history.
Parameters:
  • Username (str) - Name of the user whose message history changed.

MessageStatus(self, Message, Status)

source code 
This event is caused by a change in chat message status.
Parameters:
  • Message (ChatMessage) - Chat message object.
  • Status (enums.cms*) - New status of the chat message.

Mute(self, Mute)

source code 
This event is caused by a change in mute status.
Parameters:
  • Mute (bool) - New mute status.

Notify(self, Notification)

source code 
This event is triggered whenever Skype client sends a notification.
Parameters:
  • Notification (unicode) - Notification string.

Note: Use this event only if there is no dedicated one.

OnlineStatus(self, User, Status)

source code 
This event is caused by a change in the online status of a user.
Parameters:
  • User (User) - User object.
  • Status (enums.ols*) - New online status of the user.

PluginEventClicked(self, Event)

source code 
This event occurs when a user clicks on a plug-in event.
Parameters:

PluginMenuItemClicked(self, MenuItem, Users, PluginContext, ContextId)

source code 
This event occurs when a user clicks on a plug-in menu item.
Parameters:
  • MenuItem (PluginMenuItem) - Menu item object.
  • Users (UserCollection) - Users this item refers to.
  • PluginContext (unicode) - Plug-in context.
  • ContextId (str or int) - Context Id. Chat name for chat context or Call ID for call context.

See Also: PluginMenuItem

Reply(self, command)

source code 
This event is triggered when the API replies to a command object.
Parameters:
  • command (Command) - Command object.

SilentModeStatusChanged(self, Silent)

source code 
This event occurs when a silent mode is switched off.
Parameters:
  • Silent (bool) - Skype client silent status.

SmsMessageStatusChanged(self, Message, Status)

source code 
This event is caused by a change in the SMS message status.
Parameters:
  • Message (SmsMessage) - SMS message object.
  • Status (enums.smsMessageStatus*) - New status of the SMS message.

SmsTargetStatusChanged(self, Target, Status)

source code 
This event is caused by a change in the SMS target status.
Parameters:
  • Target (SmsTarget) - SMS target object.
  • Status (enums.smsTargetStatus*) - New status of the SMS target.

UserAuthorizationRequestReceived(self, User)

source code 
This event occurs when user sends you an authorization request.
Parameters:
  • User (User) - User object.

UserMood(self, User, MoodText)

source code 
This event is caused by a change in the mood text of the user.
Parameters:
  • User (User) - User object.
  • MoodText (unicode) - New mood text.

UserStatus(self, Status)

source code 
This event is caused by a user status change.
Parameters:
  • Status (enums.cus*) - New user status.

VoicemailStatus(self, Mail, Status)

source code 
This event is caused by a change in voicemail status.
Parameters:
  • Mail (Voicemail) - Voicemail object.
  • Status (enums.vms*) - New status of the voicemail.

WallpaperChanged(self, Path)

source code 
This event occurs when client wallpaper changes.
Parameters:
  • Path (str) - Path to new wallpaper bitmap.

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