Skip to content
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

feat: rename Target to TargetApp and update docs to match API #315

Merged
merged 1 commit into from
Feb 24, 2021

Conversation

rikoe
Copy link
Contributor

@rikoe rikoe commented Jan 28, 2021

  • rename Target type to TargetApp and target argument to app to make usage more clear
  • expand and clarify docs for raiseIntent and raiseIntentForContext
  • fix getCurrentChannel docs to include null return value

Fixes #305

This PR changes open(target: Target, context?: Context) to open(app: AppTarget, context?: Context)
and raiseIntent(intent: string, context: Context, target?: Target) to raiseIntent(intent: string, context: Context, app?: AppTarget) etc.

@rikoe rikoe added the api FDC3 API Working Group label Jan 28, 2021
@rikoe rikoe added this to the 1.2 milestone Jan 28, 2021
- rename Target type to TargetApp and target argument to app to make usage more clear
- expand and clarify docs for raiseIntent and raiseIntentForContext
- fix getCurrentChannel docs to include null return value

Fixes finos#305
@rikoe rikoe merged commit 2ed2f9c into finos:master Feb 24, 2021
@rikoe rikoe deleted the target-app-docs branch February 24, 2021 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group cla-present
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API documentation to reflect latest changes for v1.2
1 participant