summaryrefslogtreecommitdiff
path: root/doc/advertisement-monitor-api.txt
diff options
context:
space:
mode:
authorMiao-chen Chou <mcchou@chromium.org>2020-05-05 17:54:20 -0700
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2020-05-18 14:25:42 -0700
commita106a3ae3b074579839b43ffa4cf876798a2fed0 (patch)
tree6f14d502d82f981cb44266cccf3e323078267f05 /doc/advertisement-monitor-api.txt
parent9382afca3beb25400fd73c57346ce7de531c88d0 (diff)
downloadbluez-a106a3ae3b074579839b43ffa4cf876798a2fed0.tar.gz
doc/advertisement-monitor-api: Rename methods and shorten the preset strings
This renames RegisterApplication/UnregisterApplication to RegisterMonitor/UnregisterMonitor and shortens the strings used in some properties.
Diffstat (limited to 'doc/advertisement-monitor-api.txt')
-rw-r--r--doc/advertisement-monitor-api.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt
index 604448f56..74adbfae9 100644
--- a/doc/advertisement-monitor-api.txt
+++ b/doc/advertisement-monitor-api.txt
@@ -89,7 +89,7 @@ Service org.bluez
Interface org.bluez.AdvertisementMonitorManager1 [experimental]
Object path /org/bluez/{hci0,hci1,...}
-Methods void RegisterApplication(object application)
+Methods void RegisterMonitor(object application)
This registers a hierarchy of advertisement monitors.
The application object path together with the D-Bus
@@ -99,7 +99,7 @@ Methods void RegisterApplication(object application)
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.AlreadyExists
- void UnregisterApplication(object application)
+ void UnregisterMonitor(object application)
This unregisters advertisement monitors that have been
previously registered. The object path parameter must
@@ -118,7 +118,7 @@ Properties array{string} SupportedMonitorTypes [read-only]
Possible values for monitor types:
- "patterns_with_logic_or"
+ "or_patterns"
Patterns with logic OR applied. With this type,
property "Patterns" must exist and has at least
one pattern.
@@ -130,7 +130,7 @@ Properties array{string} SupportedMonitorTypes [read-only]
Possible values for features:
- "controller-based-monitor-by-patterns"
+ "controller-patterns"
If the controller is capable of performing
advertisement monitoring by patterns, BlueZ
would offload the patterns to the controller to