D-Bus интерфейс Agent1

Интерфейс позволяет управлять агентом.


Шина:	системная
Служба:	`org.bluez`
Объект:	`свободно определяемый`
Интерфейс:	`org.bluez.Agent1`

Методы

AuthorizeService(object device, string uuid)
Cancel()
DisplayPasskey(object device, uint32 passkey, uint16 entered)
DisplayPinCode(object device, string pincode)
Release()
RequestAuthorization(object device)
RequestConfirmation(object device, uint32 passkey)
uint32 RequestPasskey(object device)
string RequestPinCode(object device)

Подробное описание

Интерфейс содержит методы для настройки агента: параметры авторизации Bluetooth-соединения.

Описание методов

AuthorizeService(object device, string uuid)

Метод вызывается, когда демону необходимо авторизовать запрос на соединение/для службы.

Возможные ошибки:

org.bluez.Error.Rejected,
org.bluez.Error.Canceled.

Cancel()

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

DisplayPasskey(object device, uint32 passkey, uint16 entered)

Метод вызывается, когда демону необходимо отобразить форму для ввода пароля для аутентификации. Параметр entered указывает количество уже введённых ключей на клиентской стороне.

Должен быть возвращён пустой ответ. Когда пароль больше не нужно отображать, будет вызван метод Cancel().

В процессе сопряжения этот метод может вызываться несколько раз для обновления введённого значения.

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

DisplayPinCode(object device, string pincode)

Метод вызывается, когда демону необходимо отобразить форму для ввода пин-кода для аутентификации.

Должен быть возвращён пустой ответ. Когда пин-код больше не нужно отображать, будет вызван метод Cancel().

Метод используется во время процесса сопряжения для клавиатур, которые не поддерживают Bluetooth 2.1 Secure Simple Pairing, в отличие от DisplayPasskey, который используется для тех, которые поддерживают указанную технологию.

Метод будет вызываться только один раз, так как старые клавиатуры не поддерживают уведомление о вводе.

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

Возможные ошибки:

org.bluez.Error.Rejected,
org.bluez.Error.Canceled.

Release()

Метод вызывается, когда демон отменяет регистрацию агента. Агент может использовать его для выполнения задач по очистке. Нет необходимости вручную отменять регистрацию агента, поскольку при вызове этого метода его регистрация уже была отменена.

RequestAuthorization(object device)

Метод вызывается, чтобы запросить у пользователя авторизацию попытки сопряжения, которая в других обстоятельствах привела бы к запуску варианта «просто работает» или когда пользователь подключил устройство, реализующее сопряжение кабеля. В последнем случае устройство ещё не будет подключено к адаптеру по Bluetooth.

Возможные ошибки:

org.bluez.Error.Rejected,
org.bluez.Error.Canceled.

RequestConfirmation(object device, uint32 passkey)

Метод вызывается, когда демону службы необходимо подтвердить пароль для аутентификации.

Для подтверждения значения он должен вернуть пустой ответ или ошибку, если пароль недействителен.

Возможные ошибки:

org.bluez.Error.Rejected,
org.bluez.Error.Canceled.

uint32 RequestPasskey(object device)

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

Возвращаемое значение должно быть числовым значением от 0 до 999999.

Возможные ошибки:

org.bluez.Error.Rejected,
org.bluez.Error.Canceled.

string RequestPinCode(object device)

Метод вызывается, когда демону необходимо получить пин-код для аутентификации.

Возвращаемое значение должно быть строкой длины от 1 до 16 символов. Строка может быть буквенно-цифровой.

Возможные ошибки:

org.bluez.Error.Rejected,
org.bluez.Error.Canceled.