From d1e494b7307814fbd669a321e57bb370837cd3ab Mon Sep 17 00:00:00 2001 From: Cory McWilliams Date: Thu, 5 Oct 2023 00:24:33 +0000 Subject: [PATCH] More docs. git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@4489 ed5197a5-7fde-0310-b194-c3ffbd925b24 --- apps/api/docs.js | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/apps/api/docs.js b/apps/api/docs.js index 9b77f609..9e045bbb 100644 --- a/apps/api/docs.js +++ b/apps/api/docs.js @@ -37,6 +37,49 @@ Set the contents of the client <iframe/>. * *String* **html** The HTML contents. `; +docs['core.apps()'] = ` +Gets a list of apps owned by the current user. +### Returns +*Array* An array of string names of the apps owned by the current user. +`; + +docs['core.url'] = ` +The url by which the running app is being invoked. +`; + +docs['app.localStorageSet()'] = ` +Set a value in browser local storage. +### Parameters +*String* **key** The localStorage key to set. +*String* **value** The localStorage value to set. +`; + +docs['app.localStorageGet()'] = ` +Gets a value from browser local storage. +### Parameters +*String* **key** The key with which the value was set. +### Returns +*String* The value, or undefined. +`; + +docs['app.print()'] = ` +Log information for debugging purposes to the server and to the connected browser console. +### Parameters + * ... Any args to print. +`; + +docs['ssb.createIdentity()'] = ` +Create a new SSB identity. +### Returns +*String* The created identity public key. +`; + +docs['ssb.getIdentities()'] = ` +Get all SSB identities owned by the current user. +### Returns +*Array* An array of public key strings. +`; + docs['ssb.sqlAsync()'] = ` Run an SQL query against the sqlite database. ### Parameters