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

In Files client's API, mention the use of a davClient to retrieve a Node from a file's name #11947

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

StCyr
Copy link
Contributor

@StCyr StCyr commented Jun 30, 2024

See discussion with @susnux on cloud.nextcloud.com

☑️ Resolves

  • Fix #…

🖼️ Screenshots

@StCyr StCyr requested a review from susnux June 30, 2024 19:34
@StCyr StCyr self-assigned this Jun 30, 2024
Example
All these events use a Node as argument.

Examples
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if we really want to move documentation here, as we already have exactly this documentation and we already link to (17 lines above).
This functions might change in different versions that might all support the current version of Nextcloud.

So it might be better to just mention the documentation link above ( https://nextcloud-libraries.github.io/nextcloud-files/ )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I understand your concern, and it makes sense.

What I could write here could rather be:

All these events use a Node as argument.

You can use a webdav client (for example, by using the davGetClient function from (@nextcloud/files)[https://nextcloud-libraries.github.io/nextcloud-files/] to retrieve a node from a file's name.

Then I would also update @nextcloud/files documentation to clarify that the webdav client returned is based on webdav

what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello @susnux, I've updated my PR accordingly

@susnux susnux requested a review from skjnldsv July 1, 2024 09:09
rather mention the davClient from @nextcloud/files to get a Node from a filename

Signed-off-by: Cyrille Bollu <[email protected]>
@StCyr StCyr changed the title Adds an example how to emi files:node:* events Mention davClient to retrieve a Node from a file's name Jul 5, 2024
@StCyr StCyr changed the title Mention davClient to retrieve a Node from a file's name In Files client's API, mention the use of a davClient to retrieve a Node from a file's name Jul 5, 2024
@StCyr StCyr requested a review from susnux July 5, 2024 07:48
Copy link
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

Comment on lines +35 to 36
Examples
-------
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Examples
-------
Examples
--------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants