Skype4COM: _ISkypeEvents Interface Reference

Skype4COM

_ISkypeEvents Interface Reference

Skype event source interface. More...

import "Skype4COM.idl";

List of all members.

Public Member Functions

HRESULT Command ([in] ICommand *pCommand)
 This event indicates the command object to use with the Skype API.
HRESULT Reply ([in] ICommand *pCommand)
 This event indicates the API response to the command object.
HRESULT Error ([in] ICommand *pCommand,[in] LONG Number,[in] BSTR Description)
 This event indicates the error number and description associated with a bad command object.
HRESULT AttachmentStatus ([in] TAttachmentStatus Status)
 This event is caused by a change in the status of an attachment to the Skype API.
HRESULT ConnectionStatus ([in] TConnectionStatus Status)
 This event is caused by a connection status change.
HRESULT UserStatus ([in] TUserStatus Status)
 This event is caused by a user status change.
HRESULT OnlineStatus ([in] IUser *pUser,[in] TOnlineStatus Status)
 This event is caused by a change in the online status of a user.
HRESULT CallStatus ([in] ICall *pCall,[in] TCallStatus Status)
 This event is caused by a change in call status.
HRESULT CallHistory ()
 This event is caused by a change in call history.
HRESULT Mute ([in] VARIANT_BOOL Mute)
 This event is caused by a change in mute status.
HRESULT MessageStatus ([in] IChatMessage *pMessage,[in] TChatMessageStatus Status)
 This event is caused by a change in chat message status.
HRESULT MessageHistory ([in] BSTR Username)
 This event is caused by a change in message history.
HRESULT AutoAway ([in] VARIANT_BOOL Automatic)
 This event is caused by a change of auto away status.
HRESULT CallDtmfReceived ([in] ICall *pCall,[in] BSTR Code)
 This event is caused by a call DTMF event.
HRESULT VoicemailStatus ([in] IVoicemail *pMail,[in] TVoicemailStatus Status)
 This event is caused by a change in voicemail status.
HRESULT ApplicationConnecting ([in] IApplication *pApp,[in] IUserCollection *pUsers)
 This event is caused by users connecting to an application.
HRESULT ApplicationStreams ([in] IApplication *pApp,[in] IApplicationStreamCollection *pStreams)
 This event is caused by a change in application streams.
HRESULT ApplicationDatagram ([in] IApplication *pApp,[in] IApplicationStream *pStream,[in] BSTR Text)
 This event is caused by the arrival of an application datagram.
HRESULT ApplicationSending ([in] IApplication *pApp,[in] IApplicationStreamCollection *pStreams)
 This event is caused by a change of application sending streams.
HRESULT ApplicationReceiving ([in] IApplication *pApp,[in] IApplicationStreamCollection *pStreams)
 This event is caused by a change of application receiving streams.
HRESULT ContactsFocused ([in] BSTR Username)
 This event is caused by the contacts tab gaining or losing focus.
HRESULT GroupVisible ([in] IGroup *pGroup,[in] VARIANT_BOOL Visible)
 This event is caused by a user hiding/showing a group in the contacts tab.
HRESULT GroupExpanded ([in] IGroup *pGroup,[in] VARIANT_BOOL Expanded)
 This event is caused by a user expanding or collapsing a group in the contacts tab.
HRESULT GroupUsers ([in] IGroup *pGroup,[in] IUserCollection *pUsers)
 This event is caused by a change in a contact group.
HRESULT GroupDeleted ([in] LONG GroupId)
 This event is caused by a user deleting a custom contact group.
HRESULT UserMood ([in] IUser *pUser,[in] BSTR MoodText)
 This event is caused by a change in the mood text of the user.
HRESULT SmsMessageStatusChanged ([in] ISmsMessage *pMessage,[in] TSmsMessageStatus Status)
 This event is caused by a change in the SMS message status.
HRESULT SmsTargetStatusChanged ([in] ISmsTarget *pTarget,[in] TSmsTargetStatus Status)
 This event is caused by a change in the SMS target status.
HRESULT CallInputStatusChanged ([in] ICall *pCall,[in] VARIANT_BOOL Status)
 This event is caused by a change in the Call voice input status change.
HRESULT AsyncSearchUsersFinished ([in] LONG Cookie,[in] IUserCollection *pUsers)
 This event occurs when a search is completed.
HRESULT CallSeenStatusChanged ([in] ICall *pCall, VARIANT_BOOL Status)
 This event occurs when the seen status of a call changes.
HRESULT PluginEventClicked ([in] IPluginEvent *pEvent)
 This event occurs when a user clicks on a plug-in event.
HRESULT PluginMenuItemClicked ([in] IPluginMenuItem *pMenuItem,[in] IUserCollection *pUsers,[in] TPluginContext PluginContext,[in] BSTR ContextId)
 This event occurs when a user clicks on a menu item.
HRESULT WallpaperChanged ([in] BSTR Path)
 This event occurs when a wallpaper changes.
HRESULT FileTransferStatusChanged ([in] IFileTransfer *pTransfer,[in] TFileTransferStatus Status)
 This event occurs when a file transfer status changes.
HRESULT CallTransferStatusChanged ([in] ICall *pCall,[in] TCallStatus Status)
 This event occurs when a call transfer status changes.
HRESULT ChatMembersChanged ([in] IChat *pChat,[in] IUserCollection *pMembers)
 This event occurs when a chat members change.
HRESULT ChatMemberRoleChanged ([in] IChatMember *pMember,[in] TChatMemberRole Role)
 This event occurs when a chat member role changes.
HRESULT CallVideoStatusChanged ([in] ICall *pCall,[in] TCallVideoStatus Status)
 This event occurs when a call video status changes.
HRESULT CallVideoSendStatusChanged ([in] ICall *pCall,[in] TCallVideoSendStatus Status)
 This event occurs when a call video send status changes.
HRESULT CallVideoReceiveStatusChanged ([in] ICall *pCall,[in] TCallVideoSendStatus Status)
 This event occurs when a call video receive status changes.
HRESULT SilentModeStatusChanged ([in] VARIANT_BOOL Silent)
 This event occurs when a silent mode is switched off.
HRESULT UILanguageChanged ([in] BSTR Code)
 This event occurs when user changes Skype client language.
HRESULT UserAuthorizationRequestReceived ([in] IUser *pUser)
 This event occurs when user sends you authorization request.

Detailed Description

Skype event source interface.

Examples:

Call.php.


Member Function Documentation

HRESULT ApplicationConnecting ( [in] IApplication pApp,
[in] IUserCollection pUsers 
)

This event is caused by users connecting to an application.

Parameters:
[in]pAppcontains the interface pointer for the Application object.
[in]pUserscontains the interface pointer for the UserCollection object.
HRESULT ApplicationDatagram ( [in] IApplication pApp,
[in] IApplicationStream pStream,
[in] BSTR  Text 
)

This event is caused by the arrival of an application datagram.

Parameters:
[in]pAppcontains the interface pointer for the Application object.
[in]pStreamcontains the interface pointer for the ApplicationStream object.
[in]Textcontains the datagram text.
HRESULT ApplicationReceiving ( [in] IApplication pApp,
[in] IApplicationStreamCollection pStreams 
)

This event is caused by a change of application receiving streams.

Parameters:
[in]pAppcontains the interface pointer for the Application object.
[in]pStreamscontains the interface pointer for the ApplicationStreamCollection object.
HRESULT ApplicationSending ( [in] IApplication pApp,
[in] IApplicationStreamCollection pStreams 
)

This event is caused by a change of application sending streams.

Parameters:
[in]pAppcontains the interface pointer for the Application object.
[in]pStreamscontains the interface pointer for the ApplicationStreamCollection object.
HRESULT ApplicationStreams ( [in] IApplication pApp,
[in] IApplicationStreamCollection pStreams 
)

This event is caused by a change in application streams.

Parameters:
[in]pAppcontains the interface pointer for the Application object.
[in]pStreamscontains the interface pointer for the ApplicationStreamCollection object.
HRESULT AsyncSearchUsersFinished ( [in] LONG  Cookie,
[in] IUserCollection pUsers 
)

This event occurs when a search is completed.

Parameters:
[in]Cookiecontains the search identifier.
[in]pUserscontains the interface pointer for the UserCollection object.
See also:
ISkype::AsyncSearchUsers
HRESULT AttachmentStatus ( [in] TAttachmentStatus  Status)

This event is caused by a change in the status of an attachment to the Skype API.

Parameters:
[in]Statuscontains the new attachment status.
Examples:
Call.php.
HRESULT AutoAway ( [in] VARIANT_BOOL  Automatic)

This event is caused by a change of auto away status.

Parameters:
[in]Automaticcontains the new auto away status.
HRESULT CallDtmfReceived ( [in] ICall pCall,
[in] BSTR  Code 
)

This event is caused by a call DTMF event.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Codecontains the received DTMF code.
Note:
This event can be received with P2P calls.
HRESULT CallInputStatusChanged ( [in] ICall pCall,
[in] VARIANT_BOOL  Status 
)

This event is caused by a change in the Call voice input status change.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Statuscontains the voice input status (VARIANT_TRUE: Active, VARIANT_FALSE: Inactive).
See also:
ICall::InputDevice
HRESULT CallSeenStatusChanged ( [in] ICall pCall,
VARIANT_BOOL  Status 
)

This event occurs when the seen status of a call changes.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Statuscontains the call seen status (VARIANT_TRUE: Seen, VARIANT_FALSE: Unseen).
See also:
ICall::Seen
HRESULT CallStatus ( [in] ICall pCall,
[in] TCallStatus  Status 
)

This event is caused by a change in call status.

Parameters:
[in]pCallreceives the interface pointer for the Call object.
[in]Statuscontains the new call status.
Examples:
Call.php.
HRESULT CallTransferStatusChanged ( [in] ICall pCall,
[in] TCallStatus  Status 
)

This event occurs when a call transfer status changes.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Statuscontains the new call transfer status.
HRESULT CallVideoReceiveStatusChanged ( [in] ICall pCall,
[in] TCallVideoSendStatus  Status 
)

This event occurs when a call video receive status changes.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Statuscontains new video receive status.
HRESULT CallVideoSendStatusChanged ( [in] ICall pCall,
[in] TCallVideoSendStatus  Status 
)

This event occurs when a call video send status changes.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Statuscontains new video send status.
HRESULT CallVideoStatusChanged ( [in] ICall pCall,
[in] TCallVideoStatus  Status 
)

This event occurs when a call video status changes.

Parameters:
[in]pCallcontains the interface pointer for the Call object.
[in]Statuscontains new video status.
HRESULT ChatMemberRoleChanged ( [in] IChatMember pMember,
[in] TChatMemberRole  Role 
)

This event occurs when a chat member role changes.

Parameters:
[in]pMembercontains the interface pointer for the ChatMember object.
[in]Rolecontains the new role code.
HRESULT ChatMembersChanged ( [in] IChat pChat,
[in] IUserCollection pMembers 
)

This event occurs when a chat members change.

Parameters:
[in]pChatcontains the interface pointer for the Chat object.
[in]pMemberscontains the interface pointer for the UserCollection object.
HRESULT Command ( [in] ICommand pCommand)

This event indicates the command object to use with the Skype API.

Parameters:
[in]pCommandcontains the Command object.
HRESULT ConnectionStatus ( [in] TConnectionStatus  Status)

This event is caused by a connection status change.

Parameters:
[in]Statuscontains the new connection status.
HRESULT ContactsFocused ( [in] BSTR  Username)

This event is caused by the contacts tab gaining or losing focus.

Parameters:
[in]Usernameis an optional field to enter the Skypename of the user.
HRESULT Error ( [in] ICommand pCommand,
[in] LONG  Number,
[in] BSTR  Description 
)

This event indicates the error number and description associated with a bad command object.

Parameters:
[in]pCommandcontains the Command object.
[in]Numbercontains the error number to be returned by the Skype API.
[in]Descriptioncontains a description of the error.
HRESULT FileTransferStatusChanged ( [in] IFileTransfer pTransfer,
[in] TFileTransferStatus  Status 
)

This event occurs when a file transfer status changes.

Parameters:
[in]pTransfercontains the interface pointer for the File Transfer object.
[in]Statuscontains the new file transfer status.
See also:
ISkype::FileTransfers, ISkype::ActiveFileTransfers
HRESULT GroupDeleted ( [in] LONG  GroupId)

This event is caused by a user deleting a custom contact group.

Parameters:
[in]GroupIdcontains the ID of the deleted group.
HRESULT GroupExpanded ( [in] IGroup pGroup,
[in] VARIANT_BOOL  Expanded 
)

This event is caused by a user expanding or collapsing a group in the contacts tab.

Parameters:
[in]pGroupcontains the interface pointer for the Group object.
[in]Expandedis a Boolean indicator. When the value is set to True, the group is expanded.
HRESULT GroupUsers ( [in] IGroup pGroup,
[in] IUserCollection pUsers 
)

This event is caused by a change in a contact group.

Parameters:
[in]pGroupcontains the interface pointer for the Group object.
[in]pUserscontains the interface pointer for the UserCollection object.
HRESULT GroupVisible ( [in] IGroup pGroup,
[in] VARIANT_BOOL  Visible 
)

This event is caused by a user hiding/showing a group in the contacts tab.

Parameters:
[in]pGroupcontains the interface pointer for the Group object.
[in]Visibleis a Boolean indicator. It is set to True when the group is visible in the contacts tab.
HRESULT MessageHistory ( [in] BSTR  Username)

This event is caused by a change in message history.

Parameters:
[in]Usernamecontains the name of the user whose message history changed.
HRESULT MessageStatus ( [in] IChatMessage pMessage,
[in] TChatMessageStatus  Status 
)

This event is caused by a change in chat message status.

Parameters:
[in]pMessagereceives the interface pointer for the ChatMessage object.
[in]Statuscontains the new message status.
HRESULT Mute ( [in] VARIANT_BOOL  Mute)

This event is caused by a change in mute status.

Parameters:
[in]Mutecontains the new mute status value.
HRESULT OnlineStatus ( [in] IUser pUser,
[in] TOnlineStatus  Status 
)

This event is caused by a change in the online status of a user.

Parameters:
[in]pUserreceives the interface pointer for the User object.
[in]Statuscontains the new online status of the user.
HRESULT PluginEventClicked ( [in] IPluginEvent pEvent)

This event occurs when a user clicks on a plug-in event.

Parameters:
[in]pEventcontains the interface pointer for the PluginEvent object.
See also:
IPluginEvent
HRESULT PluginMenuItemClicked ( [in] IPluginMenuItem pMenuItem,
[in] IUserCollection pUsers,
[in] TPluginContext  PluginContext,
[in] BSTR  ContextId 
)

This event occurs when a user clicks on a menu item.

Parameters:
[in]pMenuItemcontains the interface pointer for the PluginMenuItem object.
[in]pUserscontains the interface pointer for the UserCollection object.
[in]PluginContextcontains the plug-in context.
[in]ContextIdcontains the context id.
See also:
IPluginMenuItem
HRESULT Reply ( [in] ICommand pCommand)

This event indicates the API response to the command object.

Parameters:
[in]pCommandcontains the response to the Command object.
HRESULT SilentModeStatusChanged ( [in] VARIANT_BOOL  Silent)

This event occurs when a silent mode is switched off.

Parameters:
[in]Silentcontains the Skype client silent status.
HRESULT SmsMessageStatusChanged ( [in] ISmsMessage pMessage,
[in] TSmsMessageStatus  Status 
)

This event is caused by a change in the SMS message status.

Parameters:
[in]pMessagecontains the interface pointer for the SmsMessage object.
[in]Statuscontains the new message status.
HRESULT SmsTargetStatusChanged ( [in] ISmsTarget pTarget,
[in] TSmsTargetStatus  Status 
)

This event is caused by a change in the SMS target status.

Parameters:
[in]pTargetcontains the interface pointer for the SmsTarget object.
[in]Statuscontains the new target status.
HRESULT UILanguageChanged ( [in] BSTR  Code)

This event occurs when user changes Skype client language.

Parameters:
[in]Codecontains the new language code.
HRESULT UserAuthorizationRequestReceived ( [in] IUser pUser)

This event occurs when user sends you authorization request.

Parameters:
[in]pUsercontains the the interface pointer for the User object.
HRESULT UserMood ( [in] IUser pUser,
[in] BSTR  MoodText 
)

This event is caused by a change in the mood text of the user.

Parameters:
[in]pUsercontains the interface pointer for the User object.
[in]MoodTextcontains the new mood text.
HRESULT UserStatus ( [in] TUserStatus  Status)

This event is caused by a user status change.

Parameters:
[in]Statuscontains the new user status.
HRESULT VoicemailStatus ( [in] IVoicemail pMail,
[in] TVoicemailStatus  Status 
)

This event is caused by a change in voicemail status.

Parameters:
[in]pMailcontains the interface pointer for the Voicemail object.
[in]Statuscontains the new voicemail status.
HRESULT WallpaperChanged ( [in] BSTR  Path)

This event occurs when a wallpaper changes.

Parameters:
[in]Pathto new wallpaper bitmap.
See also:
IClient::Wallpaper

The documentation for this interface was generated from the following file:

Copyright � 2006 Skype Limited. All rights reserved.