Mac Developer Library

Developer

Instant Message Service Plug-in Framework Reference

Introduction

Classes   Protocols  

The interfaces in this framework are used by instant message plug-ins to add an instant messaging service to clients such as iChat. It provides support for features such as handle availability and icons, lists of handles, group chat, and file transfers.

Classes

Class

Abstract

NSObject

NSObject is the root class of most Objective-C class hierarchies.

IMServicePlugInFileTransfer

Instances of the IMServicePlugInFileTransfer class represent file transfers.

IMServicePlugInIncomingFileTransfer

Instances of the IMServicePlugInIncomingFileTransfer class represent incoming file transfers.

IMServicePlugInOutgoingFileTransfer

Instances of the IMServicePlugInOutgoingFileTransfer class represent outgoing file transfers.

IMServicePlugInFileTransferSession

Instances of the IMServicePlugInFileTransferSession class represent file transfer sessions.

IMServicePlugInIncomingFileTransferSession

Instances of the IMServicePlugInOutgoingFileTransferSession class represent incoming file transfer sessions.

IMServicePlugInOutgoingFileTransferSession

Instances of the IMServicePlugInOutgoingFileTransferSession class represent outgoing file transfer sessions.

IMServicePlugInMessage

Instances of the IMServicePlugInMessage class represent instant messages.

Protocols

Protocol

Abstract

IMServiceApplication

A service plug-in communicates with the instant messaging client using the IMServiceApplication protocol.

IMServiceApplicationChatRoomSupport

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

IMServiceApplicationFileTransferSessionSupport

This protocol is used to pass information about handle-to-handle file transfers from the server to the instant messaging client and to provide response callbacks to methods in the IMServicePlugInFileTransferSessionSupport protocol.

IMServiceApplicationGroupListAuthorizationSupport

This protocol is used to pass group-list authorization requests from the server to the instant messaging client.

IMServiceApplicationGroupListSupport

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

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.

IMServicePlugIn

The principal class for each service plug-in must implement the IMServicePlugIn protocol.

IMServicePlugInChatRoomSupport

Implement this protocol on your service plug-in’s principal class to indicate that your service supports chat-room-based messaging.

IMServicePlugInFileTransferSessionSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service supports handle-to-handle file transfers.

IMServicePlugInGroupListAuthorizationSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service requires authorization when adding a handle to the group list.

IMServicePlugInGroupListEditingSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service supports editing the group list.

IMServicePlugInGroupListHandlePictureSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service supports handle pictures.

IMServicePlugInGroupListOrderingSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service supports ordered group lists.

IMServicePlugInGroupListSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service supports a group list.

IMServicePlugInInstantMessagingSupport

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.

IMServicePlugInPresenceSupport

Implementing this protocol on your service plug-in’s principal class indicates that your service supports presence information, such as handle availability, status message, idle state, and picture changes.