From ac1b4a47664072842aaf8525774488da86f1f6b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gre=CC=81gory=20Le=20Garec?= Date: Tue, 2 May 2017 02:23:42 +0200 Subject: [PATCH] doc: update CHANGELOG.md and docs :books: --- CHANGELOG.md | 2 +- docs/README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bc3241d3..620d6262 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/docs/README.md b/docs/README.md index cfbe898b..21202d04 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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