This adds description of SetServiceAllowList. Reviewed-by: Miao-chen Chou <mcchou@xxxxxxxxxxxx> --- doc/admin_policy-api.txt | 34 ++++++++++++++++++++++++++++++++++ doc/device-api.txt | 7 +++++++ 2 files changed, 41 insertions(+) create mode 100644 doc/admin_policy-api.txt diff --git a/doc/admin_policy-api.txt b/doc/admin_policy-api.txt new file mode 100644 index 000000000000..dd957351506a --- /dev/null +++ b/doc/admin_policy-api.txt @@ -0,0 +1,34 @@ +BlueZ D-Bus Adapter API description +*********************************** + + +Adapter hierarchy +================= + +Service org.bluez +Interface org.bluez.AdminPolicy1 +Object path [variable prefix]/{hci0,hci1,...} + +Methods void SetServiceAllowList(array{string} UUIDs) [experimental] + + This method sets the service allowlist by specifying + service UUIDs. + + When SetServiceAllowList is called, bluez will first + disconnect all the pending/existing connections and + block future incoming and outgoing connections to + the service in UUIDs for all of the clients once it + finished. + + Any subsequent calls to this method will supersede any + previously set allowlist values. Calling this method + with an empty array will allow any service UUIDs to be + used. + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.Failed + + +Properties array{string} ServiceAllowList [readonly, experimental] + + Current value of service allow list. diff --git a/doc/device-api.txt b/doc/device-api.txt index 4e824d2dec17..774ee046cc92 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -272,3 +272,10 @@ Properties string Address [readonly] Example: <Transport Discovery> <Organization Flags...> 0x26 0x01 0x01... + + bool IsBlockedByPolicy [readonly, experimental] + + Indicate whether or not this device is blocked by admin + policy. This would be true if any of its auto-connect + service does not exist in the ServiceAllowList under + org.bluez.AdminPolicy1. -- 2.31.0.291.g576ba9dcdaf-goog