IMessenger Interface

Article
07/10/2007

Deprecated. The primary interface for Microsoft Windows Messenger APIs calls. Includes methods for displaying Messenger client user interface (UI), getting or setting selected properties of the local client user, and utility methods.

IMessenger Members

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.

MyContacts 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 Deprecated in Windows Messenger 5.0. Retrieves the friendly (display) name of the local client user.

MyPhoneNumber Retrieves the stored phone number of the local client user.

MyProperty Reserved. Do not use.

MyServiceId 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 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 Deprecated in Windows Messenger 5.0. Sign-in name.

MyStatus Deprecated in Windows Messenger 5.0. Service status.

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.

ReceiveFileDirectory Retrieves the local path to the directory currently being used to store any files received through file transfer.

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.

Services Returns a list of services being used by the Messenger client.

Signin Launches the Messenger client

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.

UnreadEmailCount Retrieves the current number of unread e-mail messages in the Inbox assigned to the currently signed-in client user.

ViewProfile Launches a new browser instance, allowing the client user to view properties of the specified contact through the Public Profiles feature.

Window Gets a pointer to a MessengerWindow object that is used to control automation properties of the main application window, including dimensions, positioning, and visibility.

Remarks

Important IMessenger is no longer available in Windows Vista. See Windows Messenger for more information.

Interface Information

Stock Implementation msgsc.dll

Custom Implementation No

Inherits from IDispatch

Header and IDL files msgrua.h, msgrua.idl

Minimum availability Messenger 4.0

Minimum operating systems Windows XP

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.
MyContacts	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	Deprecated in Windows Messenger 5.0. Retrieves the friendly (display) name of the local client user.
MyPhoneNumber	Retrieves the stored phone number of the local client user.
MyProperty	Reserved. Do not use.
MyServiceId	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	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	Deprecated in Windows Messenger 5.0. Sign-in name.
MyStatus	Deprecated in Windows Messenger 5.0. Service status.
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.
ReceiveFileDirectory	Retrieves the local path to the directory currently being used to store any files received through file transfer.
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.
Services	Returns a list of services being used by the Messenger client.
Signin	Launches the Messenger client
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.
UnreadEmailCount	Retrieves the current number of unread e-mail messages in the Inbox assigned to the currently signed-in client user.
ViewProfile	Launches a new browser instance, allowing the client user to view properties of the specified contact through the Public Profiles feature.
Window	Gets a pointer to a MessengerWindow object that is used to control automation properties of the main application window, including dimensions, positioning, and visibility.

Stock Implementation	msgsc.dll
Custom Implementation	No
Inherits from	IDispatch
Header and IDL files	msgrua.h, msgrua.idl
Minimum availability	Messenger 4.0
Minimum operating systems	Windows XP

IMessenger Interface

Additional resources