Skip to content

clarify return promise #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nytamin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

clarify return promise #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion v1/specification/docs/Specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,8 @@ Graphic. The `data` field contains a (potentially partial) update of the interna
model described in the Manifest using the `schema` field.

The returned Promise MUST resolve after the execution of the update.
The point in time when the Promise is resolved SHOULD indicate that the graphic is ready to execute another action.
Typically, it could be when a graphic has finished an animation of the update.


#### customAction()
Expand All @@ -350,7 +352,12 @@ correspond to an `id` of an Action that is defined in the Manifest file, inside
`payload` field is the described in the corresponding Action inside the Manifest file. The returned Promise MUST
resolve when the action is executed.

<br>
The returned Promise MUST resolve after the execution of the update.
The point in time when the Promise is resolved SHOULD indicate that the graphic is ready to execute another action.
Typically, it could be when a graphic has finished an animation of the action.

---

Additionally, every non-real-time Graphic MUST implement the following functions.

#### goToTime()
Expand Down