Function getFavoriteNodes

Use WebDAV to query for favorite Nodes

Example

import { getClient, defaultRootPath, getFavoriteNodes } from '@nextcloud/files'

const client = getClient()
// query favorites for the root
const favorites = await getFavoriteNodes(client)
// which is the same as writing:
const favorites = await getFavoriteNodes(client, '/', defaultRootPath)
  • getFavoriteNodes(
        davClient: WebDAVClient,
        path?: string,
        davRoot?: string,
    ): CancelablePromise<Node[]>

  • Parameters

    • davClient: WebDAVClient

      The WebDAV client to use for performing the request

    • path: string = '/'

      Base path for the favorites, if unset all favorites are queried

    • davRoot: string = defaultRootPath

      The root path for the DAV user (defaults to defaultRootPath)

    Returns CancelablePromise<Node[]>

Settings

Member Visibility