diff options
Diffstat (limited to 'docs/reference-v3')
| -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 |