doc: how to open a shared file

[max-nextcloud]

Document how to provide sharingToken in an app so shared files can be opened.

Signed-off-by: Max max@nextcloud.com

[skjnldsv]

Hey @max-nextcloud , can you give me context on why you need to document that?

[max-nextcloud]

Hey @max-nextcloud , can you give me context on why you need to document that?

I ran into this twice recently. Once when opening linked files in the collectives app. Collectives can now be shared via links. Under the hood this results in sharing the collective folder. So we have a share token that we provide for Viewer.open to work and also because loading images in text relies on it.

The other occasion was when working on #995 with @vanpertsch. We ran into PROPFIND 404s when trying to open shared files. This time it turned out the sharingToken was already provided in the files_sharing app - so that was not the cause. However it made me realize that I knew we needed a sharingToken just because I recently introduced it to collectives. So it seems like something useful to document because it's hard to figure out otherwise.

I'm happy to document this elsewhere - maybe it already is and i just did not read those docs yet. What do you think would be the best place to document this?

[skjnldsv]

I'm happy to document this elsewhere - maybe it already is and i just did not read those docs yet. What do you think would be the best place to document this?

I think this is more a bad API design than a need for documentation then :)
What differs in terms of template between a file share and a collective share?
Could you point me to the code? Maybe we could actually properly get the share token, but from the viewer api instead of expecting to find it on the page.

Second thing, is actually this: nextcloud/server#19700
If we would use the same type of endpoint for private and public view, we would not need the share token I think.

[max-nextcloud]

What differs in terms of template between a file share and a collective share?

A collective share renders an empty div in the template and then loads the collectives vue app in there. So in terms of rendering it's a completely different approach from what the files_sharing app does for now.

The functionality in collectives that relies on the viewer API is opening a linked file such as a pdf on top of the collective.

Could you point me to the code? Maybe we could actually properly get the share token, but from the viewer api instead of expecting to find it on the page.
I'm not entirely sure which code you are referring to.

Viewer.open is currently called when a user clicks on a relative link to a file that is not a markdown file: https://gitlab.com/collectivecloud/collectives/-/blob/main/src/components/Page/RichText.vue#L164-172

Collectives provides the token as part of rendering the markdown view: https://gitlab.com/collectivecloud/collectives/-/blob/main/src/components/Page/RichText.vue#L3
OCA.Viewer will then pick it up here:

viewer/src/utils/davUtils.js

Lines 38 to 40 in ff759ac

	const getToken = function() {
	return document.getElementById('sharingToken') && document.getElementById('sharingToken').value
	}