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

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

Разработчик

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

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

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

IMServicePlugIn

Основной класс для каждого плагина службы должен реализовать IMServicePlugIn протокол. Реализация этого протокола указывает, что Ваш экземпляр плагина службы может выполнить основные задачи, такие как вход в систему, выходить из системы и обновление настроек учетной записи.

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

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

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

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

Swift

import IMServicePlugIn

Objective C

@import IMServicePlugIn;

Доступность

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

Выполнение основных задач
  • init (serviceApplication:) - initWithServiceApplication: Требуемый

    Инициализирует Ваш плагин службы. (требуемый)

    Объявление

    Swift

    init!(serviceApplication client: IMServiceApplication!)

    Objective C

    - (id)initWithServiceApplication:(id<IMServiceApplication>)client

    Параметры

    client

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

    Обсуждение

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

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

  • вход в систему () - вход в систему Требуемый

    Входит в систему службы мгновенных сообщений. (требуемый)

    Объявление

    Swift

    func login()

    Objective C

    - (oneway void)login

    Обсуждение

    Чтобы указать, что пользователь успешно вошел в систему, вызовите plugInDidLogIn метод на объекте клиента.

    Указать отказ входа в систему:

    • Для неправильного имени пользователя или пароля вызовите plugInDidFailToAuthenticate метод.

    • Для ошибки сервера вызовите plugInDidLogOutWithError:reconnect: метод с надлежащей ошибкой и значением NOfalse для reconnect.

    • Для сетевой ошибки вызовитеplugInDidLogOutWithError:reconnect: метод с надлежащей ошибкой и значением YEStrue для reconnect.

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

  • выход из системы () - выход из системы Требуемый

    Выходит из службы мгновенных сообщений. (требуемый)

    Объявление

    Swift

    func logout()

    Objective C

    - (oneway void)logout

    Обсуждение

    Чтобы указать, что пользователь вышел из системы, вызовите plugInDidLogOutWithError:reconnect: метод на объекте клиента, включая любую надлежащую информацию об ошибке.

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

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

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

    Объявление

    Swift

    func updateAccountSettings(_ accountSettings: [NSObject : AnyObject]!)

    Objective C

    - (oneway void)updateAccountSettings:(NSDictionary *)accountSettings

    Параметры

    accountSettings

    Словарь, содержащий настройки учетной записи. Для списка ключей посмотрите Ключи Настройки учетной записи.

    Обсуждение

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

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

    Objective C

    @import IMServicePlugIn;

    Swift

    import IMServicePlugIn

    Доступность

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

Константы
  • Ключи настройки учетной записи

    Эти ключи используются updateAccountSettings: метод.

    Объявление

    Swift

    let IMAccountSettingServerHost: NSString! let IMAccountSettingServerPort: NSString! let IMAccountSettingLoginHandle: NSString! let IMAccountSettingPassword: NSString! let IMAccountSettingUsesSSL: NSString!

    Objective C

    NSString * const IMAccountSettingServerHost; NSString * const IMAccountSettingServerPort; NSString * const IMAccountSettingLoginHandle; NSString * const IMAccountSettingPassword; NSString * const IMAccountSettingUsesSSL;

    Константы

    • IMAccountSettingServerHost

      IMAccountSettingServerHost

      Имя хоста сервера.

      Значение для этого ключа сохранено как NSString объект.

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

    • IMAccountSettingServerPort

      IMAccountSettingServerPort

      Номер порта сервера.

      Значение для этого ключа сохранено как NSNumber объект.

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

    • IMAccountSettingLoginHandle

      IMAccountSettingLoginHandle

      Дескриптор пользователя.

      Значение для этого ключа сохранено как NSString объект.

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

    • IMAccountSettingPassword

      IMAccountSettingPassword

      Пароль пользователя.

      Значение для этого ключа сохранено как NSString объект.

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

    • IMAccountSettingUsesSSL

      IMAccountSettingUsesSSL

      Использовать ли SSL.

      Значение для этого ключа является булевской переменной, сохраненной как NSNumber объект.

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