From ef8747f0328c9c7c26cec0f73017d5a661ee5b2d Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 29 Jan 2018 08:21:12 +1000 Subject: [PATCH] README: rename 'index' to 'timestamp' in GetJSONData --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 29c0631..45d539c 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ org.freedesktop.tuhi1.Device Property: DrawingsAvailable (at) An array of timestamps of the available drawings. The timestamp of - each drawing can be used as index to GetJSONData(). + each drawing can be used as argument to GetJSONData(). Read-only Property: Listening (b) @@ -204,14 +204,14 @@ org.freedesktop.tuhi1.Device signal arriving, the property DrawingsAvailable may still be updated and it's the responsibility of the client to fetch the JSON data. - Method: GetJSONData(index: t) -> (s) - Returns a JSON file with the drawings specified by the index argument. - Drawings are zero-indexed and the requested index must be less than - the DrawingsAvailable property value. See section JSON FILE FORMAT for - the format of the returned data. + Method: GetJSONData(timestamp: t) -> (s) + Returns a JSON file with the drawings specified by the timestamp + argument. Drawings are zero-indexed and the requested index must be + less than the DrawingsAvailable property value. See section JSON FILE + FORMAT for the format of the returned data. Returns a string representing the JSON data from the last drawings or - the empty string if no data is available or the index is invalid. + the empty string if no data is available or the timestamp is invalid. Signal: ButtonPressRequired() Sent when the user is expected to press the physical button on the