IMServicePlugInInstantMessagingSupport Protocol Reference

Framework
/System/Library/Frameworks/IMServicePlugIn.framework
Availability
Available in OS X v10.7 and later.
Declared in
IMServicePlugInInstantMessageSupport.h

Overview

Implementing this protocol on your service plug-in's principal class indicates that your service supports one-to-one instant messaging If you implement this protocol, you must also include IMServiceCapabilityInstantMessagingSupport as a value for the IMServiceCapabilities key in the Info.plist file of your service plug-in.

IMServicePlugInInstantMessagingSupport and IMServiceApplicationInstantMessagingSupport are paired protocols. If your service plug-in's principal class implements the IMServicePlugInInstantMessagingSupport protocol, the client object passed to your plug-in during initialization will implement the IMServiceApplicationInstantMessagingSupport protocol.

Tasks

Sending Messages

Instance Methods

sendMessage:toHandle:

Sends a message to a specific handle. (required)

- (oneway void)sendMessage:(IMServicePlugInMessage *)message toHandle:(NSString *)handle
Parameters
message

The message being sent.

handle

The recipient of the message.

Discussion

To indicate successful delivery of the message and have it show up in the instant messaging client, call the plugInDidSendMessage:toHandle:error: method with a nil error; to indicate failure, call the same method with an appropriate error.

Availability
  • Available in OS X v10.7 and later.
Declared In
IMServicePlugInInstantMessageSupport.h

userDidStartTypingToHandle:

Indicates that the user started typing a message to a specific handle from the input line. (required)

- (oneway void)userDidStartTypingToHandle:(NSString *)handle
Parameters
handle

The handle to which the user has started typing.

Availability
  • Available in OS X v10.7 and later.
Declared In
IMServicePlugInInstantMessageSupport.h

userDidStopTypingToHandle:

Indicates that the user cleared the input line after typing, instead of sending the message. (required)

- (oneway void)userDidStopTypingToHandle:(NSString *)handle
Parameters
handle

The handle to which the user started typing.

Availability
  • Available in OS X v10.7 and later.
Declared In
IMServicePlugInInstantMessageSupport.h