Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы IMServicePlugIn ссылка на протокол IMServicePlugInChatRoomSupport

Опции
Развертывание Target:

На этой странице
Язык:

IMServicePlugInChatRoomSupport

Реализуйте этот протокол на основном классе плагина своей службы, чтобы указать, что Ваша служба поддерживает основанный на чат-комнате обмен сообщениями. При реализации этого протокола необходимо также включать IMServiceCapabilityChatRoomSupport как значение для IMServiceCapabilities ключ Info.plist файл Вашего плагина службы.

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

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


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

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


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

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


Swift

import IMServicePlugIn

Objective C

@import IMServicePlugIn;

Доступность


Доступный в OS X v10.7 и позже.
  • Отклоняет приглашение чат-комнаты. (требуемый)

    Объявление

    Swift

    func declineChatRoomInvitation(_ roomName: String!)

    Objective C

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

    Параметры

    roomName

    Имя чат-комнаты, которую уменьшил пользователь.

    Обсуждение

    Этот метод вызывают только в ответ на плагин службы вызовом plugInDidReceiveInvitation:forChatRoom:fromHandle: метод на объекте клиента.

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

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

    Объявление

    Swift

    func inviteHandles(_ handles: [AnyObject]!, toChatRoom roomName: String!, withMessage message: IMServicePlugInMessage!)

    Objective C

    - (oneway void)inviteHandles:(NSArray *)handles toChatRoom:(NSString *)roomName withMessage:(IMServicePlugInMessage *)message

    Параметры

    handles

    Приглашаемые дескрипторы.

    roomName

    Имя комнаты.

    message

    Сообщение приглашения.

    Обсуждение

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

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

    Присоединяется к указанной чат-комнате. (требуемый)

    Объявление

    Swift

    func joinChatRoom(_ roomName: String!)

    Objective C

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

    Параметры

    roomName

    Имя комнаты, к которой присоединяются.

    Обсуждение

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

    • Для указания успеха вызовите plugInDidJoinChatRoom: метод на объекте клиента, сопровождаемом handles:didJoinChatRoom: указать текущие задействованные дескрипторы чат-комнаты.

    • Для указания отказа вызовите plugInDidLeaveChatRoom:error: метод на объекте клиента с ошибочным объектом описание отказа.

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

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

  • Оставляет указанную чат-комнату. (требуемый)

    Объявление

    Swift

    func leaveChatRoom(_ roomName: String!)

    Objective C

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

    Параметры

    roomName

    Имя комнаты для отъезда.

    Обсуждение

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

    Плагин службы должен попытаться чисто оставить чат-комнату, и затем вызвать plugInDidLeaveChatRoom:error: метод в клиентском интерфейсе один раз комната оставили.

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

  • Отправляет сообщение в чат-комнату. (требуемый)

    Объявление

    Swift

    func sendMessage(_ message: IMServicePlugInMessage!, toChatRoom roomName: String!)

    Objective C

    - (oneway void)sendMessage:(IMServicePlugInMessage *)message toChatRoom:(NSString *)roomName

    Параметры

    message

    Отправляемое сообщение.

    roomName

    Чат-комната получателя.

    Обсуждение

    Вызовите plugInDidSendMessage:toChatRoom:error: метод объекта клиента для создания отчетов о поставке сообщения.

    Некоторые службы мгновенных сообщений не сообщают о состоянии доставки сообщений сообщений, отправленных в чат-комнаты. Вместо этого сообщение получено таким же образом как другие входящие сообщения чат-комнаты. В этом случае плагин службы может принять решение отразить успешную поставку путем вызова plugInDidReceiveMessage:forChatRoom:fromHandle: метод, с handle набор параметра к дескриптору пользователя.

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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