-
Notifications
You must be signed in to change notification settings - Fork 146
[WIP] Expand broadcast, raise*, and open methods to include metadata #1595
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.
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
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for fdc3 failed. Why did it fail? →
|
@@ -18,3 +18,15 @@ export interface ContextMetadata { | |||
*/ | |||
readonly source: AppIdentifier; | |||
} | |||
|
|||
export interface AppProvidableContextMetadata { | |||
signature?: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why are apps limited on the metadata they can send? Shouldn't they be allowed to put anything in here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The discussions around #1290 indicated that we should limit the metadata. Let's discuss this at the next Web meeting.
}) | ||
``` | ||
|
||
### Timestamp |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need this? We already have a timestamp in the message meta I think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was in my notes as one of the few properties we should support. Let's discuss what metadata properties should be included at the next Web meeting.
Describe your change
Adds the
metadata
property at the end of the.broadcast()
,.raiseIntent()
,.raiseIntentForContext()
, and.open()
methods.Includes schema updates, doc updates, and implementation updates.
Provides placeholder space for
signature
(see #1571) andhostParams
(#1546).Related Issue
Resolves #1290
Contributor License Agreement
Review Checklist
DesktopAgent
,Channel
,PrivateChannel
,Listener
,Bridging
)?JSDoc comments on interfaces and types should be matched to the main documentation in /docs
Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
npm run build
) run and the results checked in?Generated code will be found at
/src/api/BrowserTypes.ts
and/or/src/bridging/BridgingTypes.ts
BaseContext
schema applied viaallOf
(as it is in existing types)?title
anddescription
provided for all properties defined in the schema?npm run build
) run and the results checked in?Generated code will be found at
/src/context/ContextTypes.ts