Skip to content

Commit 7e18d73

Browse files
committedJun 3, 2018
chore(api): announce old edit method & event deprecation
1 parent 46c8453 commit 7e18d73

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed
 

‎README.md

+4-11
Original file line numberDiff line numberDiff line change
@@ -520,17 +520,8 @@ embed.setEditorConfig({
520520

521521
### `edit(operations: object): Promise<void, Error>`
522522

523-
Process some edit operations using one of our internal editing method. Feel free to [contact our developers support](mailto:developers@flat.io) to get more information about the operations available.
524-
525-
```js
526-
embed.edit([
527-
{ name: 'action.SetTitle', opts: { title: 'I <3 Flat'} }
528-
]).then(function () {
529-
// The actions have been executed
530-
}).catch(function (error) {
531-
// Error while executing the actions
532-
});
533-
```
523+
**NOTE: This method is now deprecated. Dedicated editing methods will be available in the upcoming weeks.
524+
[Please contact our team](mailto:developers@flat.io) if you are interested in using them.**
534525

535526
## Events API
536527

@@ -613,6 +604,8 @@ This event is triggered when the playback slider moves. It is usually triggered
613604

614605
### Event: `edit`
615606

607+
**NOTE: This event format will change in the upcoming weeks for simpler edit information, the current format is now deprecated. [Please contact our team](mailto:developers@flat.io) if you are interested in using the new format.**
608+
616609
This event is triggered when one or multiple modifications ave been made to the document. This one will contain a list of operations made:
617610

618611
```json

0 commit comments

Comments
 (0)
Please sign in to comment.