IMServiceApplicationChatRoomSupport

Этот протокол используется, чтобы передать входящие события чат-комнаты от сервера до клиента мгновенного обмена сообщениями и обеспечить обратные вызовы ответа для методов в IMServicePlugInChatRoomSupport протокол.

IMServiceApplicationChatRoomSupport и IMServicePlugInChatRoomSupport соединенные протоколы. Если основной класс плагина Вашей службы реализует IMServicePlugInChatRoomSupport протокол, объект клиента, переданный Вашему плагину во время инициализации, реализует IMServiceApplicationChatRoomSupport протокол.

Наследование

Не применимый

Соответствует

Оператор импорта

Swift

import IMServicePlugIn

Objective C

@import IMServicePlugIn;

Доступность

Доступный в OS X v10.7 и позже.

Присоединение и отъезд чат-комнаты


    
    дескрипторы (_: didJoinChatRoom:)
    - handles:didJoinChatRoom:

Требуемый

Указывает, что данные дескрипторы присоединились к чат-комнате. (требуемый)

Объявление

Swift

func handles(_ handles: [AnyObject]!, didJoinChatRoom roomName: String!)

Objective C

- (oneway void)handles:(NSArray *)handles didJoinChatRoom:(NSString *)roomName

Параметры

`handles`	Массив `NSString` объекты, соответствующие дескрипторам, присоединившимся к комнате.
`roomName`	Имя чат-комнаты.

Обсуждение

Этот метод может также использоваться для ответа первоначального списка элементов чат-комнаты после вызова plugInDidJoinChatRoom: метод.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.


    
    дескрипторы (_: didLeaveChatRoom:)
    - handles:didLeaveChatRoom:

Требуемый

Указывает, что данные дескрипторы оставили чат-комнату. (требуемый)

Объявление

Swift

func handles(_ handles: [AnyObject]!, didLeaveChatRoom roomName: String!)

Objective C

- (oneway void)handles:(NSArray *)handles didLeaveChatRoom:(NSString *)roomName

Параметры

`handles`	Массив `NSString` объекты, соответствуя дескрипторам, покинувшим комнату.
`roomName`	Имя чат-комнаты.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.

plugInDidJoinChatRoom (_:) - plugInDidJoinChatRoom: Требуемый

Указывает, что пользователь успешно присоединился к чат-комнате. (требуемый)

Объявление

Swift

func plugInDidJoinChatRoom(_ roomName: String!)

Objective C

- (oneway void)plugInDidJoinChatRoom:(NSString *)roomName

Параметры

roomName

Имя чат-комнаты.

Обсуждение

Когда плагин службы вызывает этот метод на объекте клиента, клиент мгновенного обмена сообщениями указывает пользователю, что к указанной чат-комнате присоединились и готова получить сообщения.

Этот метод обычно вызывают в ответ на joinChatRoom: метод, вызываемый на плагине службы.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.


    
    plugInDidLeaveChatRoom (_: ошибка:)
    - plugInDidLeaveChatRoom:error:

Требуемый

Указывает, что пользователь успешно оставил чат-комнату. (требуемый)

Объявление

Swift

func plugInDidLeaveChatRoom(_ roomName: String!, error error: NSError!)

Objective C

- (oneway void)plugInDidLeaveChatRoom:(NSString *)roomName error:(NSError *)error

Параметры

`roomName`	Имя чат-комнаты.
`error`	Ошибка, если таковые имеются, который заставил пользователя быть удаленным из чат-комнаты или препятствовал тому, чтобы пользователь присоединился к чат-комнате.

Обсуждение

Пользователь может попытаться повторно войти в чат-комнату в будущем.

Этот метод можно также вызвать в ответ на joinChatRoom: метод, вызываемый на плагине службы, чтобы указать, что ошибка произошла при присоединении к комнате.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.

Отправка и получение сообщений


    
    plugInDidReceiveInvitation (_: forChatRoom:fromHandle:)
    - plugInDidReceiveInvitation:forChatRoom:fromHandle:

Требуемый

Указывает, что было получено приглашение чат-комнаты. (требуемый)

Объявление

Swift

func plugInDidReceiveInvitation(_ invitation: IMServicePlugInMessage!, forChatRoom roomName: String!, fromHandle handle: String!)

Objective C

- (oneway void)plugInDidReceiveInvitation:(IMServicePlugInMessage *)invitation forChatRoom:(NSString *)roomName fromHandle:(NSString *)handle

Параметры

`invitation`	Сообщение приглашения. Если `nil`, клиент мгновенного обмена сообщениями использует сообщение приглашения по умолчанию.
`roomName`	Имя чат-комнаты.
`handle`	Отправитель приглашения.

Обсуждение

Когда плагин службы вызывает этот метод на объекте клиента, дисплеи клиента мгновенного обмена сообщениями приглашение от указанного дескриптора для чат-комнаты.

Если пользователь принимает приглашение, клиент мгновенного обмена сообщениями вызывает joinChatRoom: метод на плагине службы; если пользователь уменьшается, клиент вызывает declineChatRoomInvitation: метод на плагине службы.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.


    
    plugInDidReceiveMessage (_: forChatRoom:fromHandle:)
    - plugInDidReceiveMessage:forChatRoom:fromHandle:

Требуемый

Указывает, что было получено сообщение чат-комнаты. (требуемый)

Объявление

Swift

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

Objective C

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

Параметры

`message`	Сообщение.
`roomName`	Имя чат-комнаты.
`handle`	Отправитель сообщения.

Обсуждение

Когда плагин службы вызывает этот метод на объекте клиента, дисплеи клиента мгновенного обмена сообщениями сообщение в копии для указанной чат-комнаты.

Этот метод может использоваться для указания успешной поставки сообщения, отправленного через IMServicePlugInInstantMessagingSupport sendMessage:toHandle: метод.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.

plugInDidReceiveNotice (_: forChatRoom:) - plugInDidReceiveNotice:forChatRoom: Требуемый

Указывает, что уведомление было получено в чат-комнате. (требуемый)

Объявление

Swift

func plugInDidReceiveNotice(_ notice: String!, forChatRoom roomName: String!)

Objective C

- (oneway void)plugInDidReceiveNotice:(NSString *)notice forChatRoom:(NSString *)roomName

Параметры

notice

Текст уведомления.

roomName

Имя чат-комнаты.

Обсуждение

Когда плагин службы вызывает этот метод на объекте клиента, дисплеи клиента мгновенного обмена сообщениями информационное сообщение в копии для указанной чат-комнаты.

Плагин Службы IM API не поддерживает свойства чат-комнаты, такие как тема, состояние модератора или настройки чат-комнаты; клиенты могут использовать этот метод для отображения дополнительной информации, которая иначе была бы скрыта пользователю.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.


    
    plugInDidSendMessage (_: toChatRoom:error:)
    - plugInDidSendMessage:toChatRoom:error:

Требуемый

Указывает, что было отправлено сообщение чат-комнаты. (требуемый)

Объявление

Swift

func plugInDidSendMessage(_ message: IMServicePlugInMessage!, toChatRoom roomName: String!, error error: NSError!)

Objective C

- (oneway void)plugInDidSendMessage:(IMServicePlugInMessage *)message toChatRoom:(NSString *)roomName error:(NSError *)error

Параметры

`message`	Сообщение.
`roomName`	Имя чат-комнаты.
`error`	Ошибка, если один произошел во время доставки сообщений.

Обсуждение

Этот метод может использоваться для указания успешной поставки сообщения, отправленного через sendMessage:toChatRoom: метод.

Оператор импорта

Objective C

@import IMServicePlugIn;

Swift

import IMServicePlugIn

Доступность

Доступный в OS X v10.7 и позже.

`notice`	Текст уведомления.
`roomName`	Имя чат-комнаты.