Skip to content

Commit

Permalink
doc: update CHANGELOG.md and docs 📚
Browse files Browse the repository at this point in the history
  • Loading branch information
gregorylegarec committed May 2, 2017
1 parent 6bb9e62 commit ac1b4a4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- none yet

### Added
- Temporary `cozy.client.fetchJSON()`, to facilitated development process.
- `cancel()` method on service object returned by `cozy.client.intents.createService()``

### Removed
- none yet
Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,8 @@ See cozy-stack [documentation](https://github.com/cozy/cozy-stack/blob/master/do
`cozy.client.intents.createService(intentId, window)` has to be used in the intent service page. It initializes communication with the parent window (remember: the service is supposed to be in an iframe). It returns a *service* object, which provides the following methods :
* `getData()`: returns the data passed to the service by the client.
* `getIntent()`: returns the intent
* `terminated(doc)`: ends the intent process by passing to the client the resulting document `doc`. An intent service may only be terminated once.
* `terminate(doc)`: ends the intent process by passing to the client the resulting document `doc`. An intent service may only be terminated once.
* `cancel()`: ends the intent process by passing a `null` value to the client. This method terminate the intent service the same way that `terminate()`.

#### Example
```js
Expand Down

0 comments on commit ac1b4a4

Please sign in to comment.