Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PDS Client 2.0 JavaScript API"
m |
m |
||
| Line 1: | Line 1: | ||
| − | = | + | = Introduction = |
The JavaScript API allows the developer (the API consumer) to simply treat the PDS Client and any personal or managed data stores in the cloud as one big database. It allows you to read or write in a single operation a set of attributes and their values. | The JavaScript API allows the developer (the API consumer) to simply treat the PDS Client and any personal or managed data stores in the cloud as one big database. It allows you to read or write in a single operation a set of attributes and their values. | ||
The JavaScript API is implemented by a NPAPI browser plugin that is used in the user’s “regular” browser as well as the Dashboard’s embedded browser. This API is intended to support a variety of apps that need access to data about the current user. | The JavaScript API is implemented by a NPAPI browser plugin that is used in the user’s “regular” browser as well as the Dashboard’s embedded browser. This API is intended to support a variety of apps that need access to data about the current user. | ||
| + | |||
| + | = Applications = | ||
| + | |||
| + | The following apps being developed in Higgins consume this API by Javascript calls specified by an app-card: | ||
| + | * Password Manager | ||
| + | * Form filler | ||
| + | * App-Card Framework | ||
| + | |||
| + | = Complexity Hiding = | ||
| + | |||
| + | This API doesn't require the consumer to understand nor have to navigate the structured nature of that some attributes in the Persona Data Model 2.0 (PDM) have. Similarly it doesn’t require the consumer to understand nor have to navigate the graph structure of the underlying p:Person nodes in this data model. Instead it hides all of these complexities. | ||
| + | |||
| + | For example, the fact that in the PDM we might have a p:person node of role “payer” with a vcard:adr link to a v:Address object that in turn has a vcard:street-name attribute and value is hidden. The getRPAttributes() consumer simply has to ask for the "payer street name" attribute and they will get back a literal string value like "123 main street”. | ||
= TBD = | = TBD = | ||
Revision as of 11:09, 8 November 2010
Introduction
The JavaScript API allows the developer (the API consumer) to simply treat the PDS Client and any personal or managed data stores in the cloud as one big database. It allows you to read or write in a single operation a set of attributes and their values.
The JavaScript API is implemented by a NPAPI browser plugin that is used in the user’s “regular” browser as well as the Dashboard’s embedded browser. This API is intended to support a variety of apps that need access to data about the current user.
Applications
The following apps being developed in Higgins consume this API by Javascript calls specified by an app-card:
- Password Manager
- Form filler
- App-Card Framework
Complexity Hiding
This API doesn't require the consumer to understand nor have to navigate the structured nature of that some attributes in the Persona Data Model 2.0 (PDM) have. Similarly it doesn’t require the consumer to understand nor have to navigate the graph structure of the underlying p:Person nodes in this data model. Instead it hides all of these complexities.
For example, the fact that in the PDM we might have a p:person node of role “payer” with a vcard:adr link to a v:Address object that in turn has a vcard:street-name attribute and value is hidden. The getRPAttributes() consumer simply has to ask for the "payer street name" attribute and they will get back a literal string value like "123 main street”.
TBD
Warning - Work in progress.
JavaScript APIs
addEntityAttributes setEntityAttributes delEntityAttributes getEntityAttributes setRPAttributes getRPAttributes getSuggestions
Dashboard APIs
removePWData getPWException removePWException removeRMCard