Custom URL scheme for opening a note

Question

Custom URL scheme for opening a note

ylian opened this issue 9 years ago · 23 comments

A custom URL scheme can provide a way for another app, even a webpage, to open a Quiver note from a link. This applies to both OS X and iOS.

quiver://[host]/[action]?[query]

Also on both platforms, a custom URL scheme makes web clipping possible. A web clipper (a helper app) can be implemented on both iOS and OS X, and when clipping a page, will call the custom URL scheme to create a note.

Also, on iOS, using a custom URL scheme has been the standard way of implementing inter-app communication. iOS 8 introduces app extensions, which Quiver will implement, but the custom URL scheme is still useful.

livfwd commented 9 years ago

Awesome!

Answer 1 · 2015-04-19T16:36:58.000Z

Implemented in 2.2b26. Currently it only supports one URL quiver://notes/{noteID}, but this sets the stage for other things like web clipping and workflow integration with Alfred.

https://dl.dropboxusercontent.com/u/3445731/Quiver%202.2b26.zip

Answer 2 · 2015-11-20T00:52:54.000Z

Any plans to make this link format available in Quiver for pasting into other apps? Perhaps as an alt version of 'copy note link'?

Answer 3 · 2015-11-20T01:55:56.000Z

Yep that's the plan all along. This feature was taken out in the last minute because it's inter-connected with a few other things, and I didn't want to introduce a public scheme prematurely.

Answer 4 · 2015-11-20T02:53:22.000Z

OK thanks. And congrats on a top-notch 3.0 release.

Answer 5 · 2015-11-20T02:57:09.000Z

Oh one more thing. Can we rely on the quiver://notes/{noteID} form being stable? I'm thinking in terms of manually formatting links where needed for now.

Answer 6 · 2015-11-20T03:08:09.000Z

There is one small thing that I'm not sure. Should it be quiver:///notes/{noteId} or quiver://notes/{noteId}? The former is more standard compliant (URL spec), but the latter seems more natural for me.

Answer 7 · 2015-11-20T03:15:49.000Z

I'd be inclined to stay with the standard. I'm no expert, but urls without hostnames always have 3 backslashes, and who knows what tools someone might want to use that might depend on standard url parsers etc?

Answer 8 · 2015-11-20T03:19:22.000Z

Yep, that makes sense. So that's decided - quiver:///notes/{noteId}.

Answer 9 · 2015-11-20T03:31:48.000Z

Great, cheers.

Answer 10 · 2016-01-06T15:12:33.000Z

Is that correct?

open "quiver:///notes/65822832-0CBE-4D4C-83BE-EBEAD6FC3FD9"

it opens Quiver but dosen't shows the note.

65822832-0CBE-4D4C-83BE-EBEAD6FC3FD9 is a valid {noteId}

Answer 11 · 2016-01-06T15:14:20.000Z

@mbelletti It's not yet in the release build. You can try the build here: https://dl.dropboxusercontent.com/u/3445731/Quiver%203.0.1b1.zip

Answer 12 · 2016-01-06T15:14:59.000Z

Very fast reaction! :-)

Thank you

Answer 13 · 2016-01-06T15:15:48.000Z

@mbelletti I will push out 3.0.1 in a couple of days. This will be in.

Answer 14 · 2016-01-07T09:40:27.000Z

@ylian It seems that also 3.0.1 doesn't work as expected.

open "quiver:///notes/65822832-0CBE-4D4C-83BE-EBEAD6FC3FD9"

open Quiver but not the note.

Answer 15 · 2016-01-07T19:39:43.000Z

@mbelletti It seems to open work if Quiver is already open. Will fix.

Answer 16 · 2016-01-17T14:09:30.000Z

#361 fix the problem to me.
Thank you!

Answer 17 · 2016-01-24T17:03:34.000Z

@ylian after you right-click or control-click on note in the note-list, would it be possible to either add this new solution as a "copy external note link" option in the cmenu that pops-up, or to do something similar to what evernote has done and after the right-click/control-click menu pops-up, then you could hit the option key to change "copy note link" (which works in-app) to "copy external note link) for this new, quiver:///notes/{noteId}, solution you've created? Awesome app!

Answer 18 · 2016-01-24T18:33:01.000Z

@livfwds Great idea! Will do.

Answer 19 · 2016-01-24T20:36:21.000Z

Thanks so much!

Answer 20 · 2016-02-09T01:14:55.000Z

The URL scheme is implemented in 3.0.1.

@livfwds In 3.0.1, if you "copy note link", it should just work. When you paste into an external app, it will be an external note link (quiver:///notes/{noteId}). When you paste into a text cell, it will be an internal note link (quiver-note-url/{noteId}). When pasted into a Markdown cell, it will be a Markdown link ([note](quiver-note-url/{noteId}).

I will open a new ticket for other URL schemes.

Answer 21 · 2019-04-10T03:50:12.000Z

Question - is there a way to use this schema to open quiver to start writing a new quiver note from the command line? Something like:
open quiver:///notes/

I tried that but that doesn't see an option.

Answer 22 · 2019-04-11T11:39:13.000Z

@dbirch-cb There is a custom URL used by the Quiver Web Clipper:

quiver://actions/create-note?type={type}&title={title}&content={content}

Create a new note.

Parameters:

type (optional): The type of the note ("text", "markdown"). Defaults to "text".
title (optional): The title of the note. Defaults to an empty string.
content (optional): The content of the note. If not specified, the content of the clipboard will be used.

Example:

quiver://actions/create-note?title=New%20Note&type=markdown