diff options
author | José Bollo <jose.bollo@iot.bzh> | 2018-07-27 17:38:22 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2018-08-02 15:49:43 +0200 |
commit | 5ef271effacb83552f9ea56572c751c2f5a556b6 (patch) | |
tree | 3d5f6665bde93633b0eb6c648c9ab46951443526 /docs/reference-v3/func-api.md | |
parent | e39610f8c9b2e6bbb8a460f7d7ccccbc5161b4ed (diff) |
Add ability to provide binding settings
Change-Id: Iab93a26340fa9743a58ca43cd903bbf31c783e5b
Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs/reference-v3/func-api.md')
-rw-r--r-- | docs/reference-v3/func-api.md | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/reference-v3/func-api.md b/docs/reference-v3/func-api.md index 535bff85..ef3816d0 100644 --- a/docs/reference-v3/func-api.md +++ b/docs/reference-v3/func-api.md @@ -58,7 +58,7 @@ void afb_api_set_userdata( * Check that it requires the API of 'name'. * If 'initialized' is not zero it requests the API to be * initialized, implying its initialization if needed. - * + * * Calling this function is only allowed within init. * * A single request allows to require multiple apis. @@ -255,6 +255,24 @@ int afb_api_rootdir_open_locale( const char *locale); ``` +### afb_api_settings + +```C +/** + * Settings of the api. + * + * Get the settings of the API. The settings are recorded + * as a JSON object. The returned object should not be modified. + * It MUST NOT be released using json_object_put. + * + * @param api the api whose settings are required + * + * @returns The setting object. + */ +struct json_object *afb_api_settings( + struct afb_api_x3 *api); +``` + ## Calls and job functions ### afb_api_call |