Event Affordance subscription and cancellation payloads are not usable by scripting
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 45
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
In the TD spec, the Event affordance has the subscription and cancellation keys. With these keys, one can describe a payload that needs to be passed along for subscribing or unsubscribing from an event.
In the Scripting API, this behavior is not specified explicitly for the subscribeevent method and is not specified at all for the unsubscribeevent method. For subscribeevent, it is said that one can use InteractionOptions vocabulary which however says that currently they are used only for URI variables. For unsubscribeevent, InteractionOptions do not seem to be even allowed.
A further discussion would be whether these are actually interaction options or params like the invokeAction() method.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Scripting API sections for subscribeevent and unsubscribeevent, then compare their allowed InteractionOptions with the TD subscription and cancellation keys. Done means the specification explicitly defines how subscription and cancellation payloads are passed and resolves whether they are interaction options or params.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100