IMessenger interface
[IMessenger is no longer available for use as of Windows Vista. See Windows Messenger for more information.]
Do not use. The primary interface for Windows Messenger APIs calls. Includes methods for displaying Messenger client UI, getting or setting selected properties of the local client user, and utility methods.
Members
The IMessenger interface inherits from the IDispatch interface. IMessenger also has these types of members:
Methods
The IMessenger interface has these methods.
| Method | Description |
|---|---|
| AddContact | Launches the Add a Contact wizard. |
| AutoSignin | Signs the local client in automatically using the last sign-in name and saved password information. |
| FindContact | Launches the Add a Contact wizard to the screen used for finding a contact based on information supplied as input parameters. |
| GetContact | Creates a MessengerContact object that can be used to call methods of the Windows Messenger interfaces, such as IMessenger, IMessengerContact, and IMessengerContacts. |
| InstantMessage | Launches a conversation window with the initial recipient specified as a parameter. |
| InviteApp | Issues an invitation to a user to use a specified application. |
| MediaWizard | Launches the Audio and Video Tuning Wizard dialog box. |
| OpenInbox | Launches the default e-mail application and opens the Inbox. |
| OptionsPages | Launches the Options dialog box with a specified tab displayed. |
| Page | Launches the Page window that is used to page a user, as designated by the input parameter. |
| Phone | Launches the Phone Call dialog box. |
| SendFile | Launches the Send File mode of a conversation window to a specified contact. |
| SendMail | Launches a new message in the client's default e-mail application with the To: line prepopulated with the sign-in name of the specified contact. |
| Signin | Launches the Messenger client Sign In dialog box and populates the sign-in name field. The behavior of this method will vary, depending on the Messenger client version, the host operating system, and the primary service for the client. For more information, see the Remarks section later in this topic. |
| Signout | Signs the current client user out of all Mesenger services. |
| StartVoice | Launches a Messenger conversation window to initiate a voice message session with a particular contact, pending acceptance of the invitation. |
| ViewProfile | Launches a new browser instance, allowing the client user to view properties of the specified contact through the Public Profiles feature. |
Properties
The IMessenger interface has these properties.
| Property | Access type | Description |
|---|---|---|
| MyContacts |
Read-only |
Retrieves the contact list contained in the client or Messenger object. The retrieved list is a MessengerContacts collection object that can be manipulated with the IMessengerContacts interface. |
| MyFriendlyName |
Read-only |
Deprecated in Windows Messenger 5.0. Retrieves the friendly (display) name of the local client user. |
| MyPhoneNumber |
Read-only |
Retrieves the stored phone number of the local client user. |
| MyProperty |
Read-only |
Reserved. Do not use. |
| MyServiceId |
Read-only |
Deprecated in Windows Messenger 5.0. Retrieves the service ID, a GUID, of the primary service to which the local client user is currently signed in. |
| MyServiceName |
Read-only |
Deprecated in Windows Messenger 5.0. Retrieves the service name of the primary service to which the local client user is currently signed in. |
| MySigninName |
Read-only |
Deprecated in Windows Messenger 5.0. Sign-in name. |
| MyStatus |
Read-only |
Deprecated in Windows Messenger 5.0. Service status. |
| ReceiveFileDirectory |
Read-only |
Retrieves the local path to the directory currently being used to store any files received through file transfer. |
| Services |
Read-only |
Returns a list of services being used by the Messenger client. |
| UnreadEmailCount |
Read-only |
Retrieves the current number of unread e-mail messages in the Inbox assigned to the currently signed-in client user. |
| Window |
Read-only |
Gets a pointer to a MessengerWindow object that is used to control automation properties of the main application window, including dimensions, positioning, and visibility. |
Requirements
| Minimum supported client |
Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| End of client support |
Windows XP |
| End of server support |
Windows Server 2003 |
| Product |
Messenger 4.0 |
| Header |
|
| IDL |
|
| DLL |
|