Skip to content

Finalize UriHandler API#52812

Merged
joaomoreno merged 9 commits intomasterfrom
joao/uri-handler
Jul 6, 2018
Merged

Finalize UriHandler API#52812
joaomoreno merged 9 commits intomasterfrom
joao/uri-handler

Conversation

@joaomoreno
Copy link
Copy Markdown
Member

I've made the following changes as discussed in the API call:

  • Improve documentation
  • Rename to UriHandler
  • handleUri now returns ProviderResult<void> and we log errors, if any

@joaomoreno joaomoreno added this to the June 2018 milestone Jun 25, 2018
@joaomoreno joaomoreno self-assigned this Jun 25, 2018
@joaomoreno joaomoreno requested a review from jrieken June 25, 2018 14:17
@joaomoreno joaomoreno changed the title Joao/uri handler Finalize UriHandler API Jun 25, 2018
Comment thread src/vs/vscode.d.ts Outdated

/**
* Registers a [Uri handler](#UriHandler) capable of handling system-wide [Uris](#Uri).
* In case there are multiple windows open, the topmost window will handle the Uri.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use lower-case uri for consistency

Comment thread src/vs/vscode.d.ts Outdated
*
* For example, if the `vscode.git` extension registers a Uri handler, it will only
* be allowed to handle Uris with the prefix `{scheme}://vscode.git`, in which `{scheme}`
* is either `vscode` or `vscode-insiders`. All the following Uris are examples:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is tricky, we don't use product-names in the documentation. I usually use 'the editor' but something better is needed for those samples.

Also, add some clarity or familiar uri-terms, like: The uri-scheme must be the product name, the uri-authority must be the extension id, the path, query, and fragment can be chosen freely.

@joaomoreno
Copy link
Copy Markdown
Member Author

Pushed updates.

@joaomoreno joaomoreno modified the milestones: June 2018, July 2018 Jun 26, 2018
@joaomoreno
Copy link
Copy Markdown
Member Author

Let's try to remove branding from the documentation.

@joaomoreno
Copy link
Copy Markdown
Member Author

@jrieken Removed product specific language from the docs. Up for final review.

Comment thread src/vs/vscode.d.ts Outdated
*
* Extensions that support reviving should have an `"onWebviewPanel:viewType"` activation event and
* make sure that [registerWebviewPanelSerializer](#registerWebviewPanelSerializer) is called during activation.
* Extensions that support reviving should have an`"onWebviewPanel:viewType"` activation event and
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bad change?

Copy link
Copy Markdown
Member

@jrieken jrieken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jrieken
Copy link
Copy Markdown
Member

jrieken commented Jul 6, 2018

Seems to have an accidental change but apart from that 🚢 it.

@joaomoreno
Copy link
Copy Markdown
Member Author

Good catch. I used the git merge ui for the first time. 🤦‍♂️

@joaomoreno joaomoreno merged commit d1f8ff6 into master Jul 6, 2018
@joaomoreno joaomoreno deleted the joao/uri-handler branch July 6, 2018 13:43
@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants