Mac Developer Library

Developer

IMServicePlugIn Framework Reference IMServiceApplicationInstantMessagingSupport Protocol Reference

Options
Deployment Target:

On This Page
Language:

IMServiceApplicationInstantMessagingSupport

This protocol is used to pass incoming instant messaging events from the server to the instant messaging client and to provide response callbacks to methods in the IMServicePlugInInstantMessagingSupport protocol. More...

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


import IMServicePlugIn @import IMServicePlugIn;

Availability


Available in OS X v10.7 and later.
  • Indicates that the handle is typing. (required)

    Declaration

    Swift

    func handleDidStartTyping(_ handle: String!)

    Objective-C

    - (oneway void)handleDidStartTyping:(NSString *)handle

    Parameters

    handle

    The handle that started typing.

    Discussion

    This method causes iChat to display a thought bubble in the chat transcript.

    To clear the thought bubble, call the handleDidStopTyping: method.

    To replace the thought bubble with an actual message, call the plugInDidReceiveMessage:fromHandle: method.

    Import Statement

    import IMServicePlugIn

    Availability

    Available in OS X v10.7 and later.

  • Indicates that the handle stopped typing. (required)

    Declaration

    Swift

    func handleDidStopTyping(_ handle: String!)

    Objective-C

    - (oneway void)handleDidStopTyping:(NSString *)handle

    Parameters

    handle

    The handle that stopped typing.

    Discussion

    This method causes iChat to remove a thought bubble icon from the chat transcript.

    Import Statement

    import IMServicePlugIn

    Availability

    Available in OS X v10.7 and later.

  • Indicates that a message was received and needs to be presented to the user. (required)

    Declaration

    Swift

    func plugInDidReceiveMessage(_ message: IMServicePlugInMessage!, fromHandle handle: String!)

    Objective-C

    - (oneway void)plugInDidReceiveMessage:(IMServicePlugInMessage *)message fromHandle:(NSString *)handle

    Parameters

    message

    The incoming message.

    handle

    The sender of the message.

    Import Statement

    import IMServicePlugIn

    Availability

    Available in OS X v10.7 and later.

  • Indicates whether an outgoing instant message was sent. (required)

    Declaration

    Swift

    func plugInDidSendMessage(_ message: IMServicePlugInMessage!, toHandle handle: String!, error error: NSError!)

    Objective-C

    - (oneway void)plugInDidSendMessage:(IMServicePlugInMessage *)message toHandle:(NSString *)handle error:(NSError *)error

    Parameters

    message

    The incoming message.

    handle

    The sender of the message.

    error

    The error, if any, that occurred during message delivery.

    Discussion

    If the error parameter is nil, the instant messaging client appends the message to the active chat with the handle. Otherwise, the instant messaging client displays an error informing the user that the message could not be delivered.

    This method should be called once in response to each time the IMServicePlugInInstantMessagingSupport method sendMessage:toHandle: is called.

    Import Statement

    import IMServicePlugIn

    Availability

    Available in OS X v10.7 and later.