coolaj86
/
oauth3.js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add prototype docs

This commit is contained in:
aj 2017-08-10 21:15:54 +00:00
parent 937a681c5d
commit 80d462c231
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -329,9 +329,19 @@ promise = oauth3.authenticate(); // opens login window for th
promise = oauth3.authorize(permissions); // authenticates (if not authenticated) and opens a window to
// authorize a particular scope (contacts, photos, whatever)
promise = oauth3.request({ url, method, data }); // make an (authorized) request to a provider's resource
promise = oauth3.request({ url, method, data }); // make an (authorized) arbitrary request to an audience's resource
// (contacts, photos, whatever)
promise = oauth3.api(apiname, opts); // make an (authorized) well-known api call to an audience
// See https://labs.daplie.com/docs/ for API schemas
// Ex: oauth3.api('dns.list', { sld: 'daplie', tld: 'com' });
// TODO
api = await oauth3.package(audience, schemaname); // make an (authorized) well-known api call to an audience
// Ex: api = await oauth3.package('domains.daplie.com', 'dns@oauth3.org');
// api.list({ sld: 'mydomain', tld: 'com' });
promise = oauth3.logout(); // opens logout window for the provider
oauth3.session(); // returns the current session, if any