Skip to content

browseSnapshotFileConnection

Returns a list files whose name is prefixed by the query in the given snapshot.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last Int Returns the last n elements from the list.
before String An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
snapshotFid (required) UUID! Snapshot persistent UUID in RSC.
path (required) String! The path under which you want your search to run.
searchPrefix String Prefix arg for searching for files within a snapshot.
isPrefixSearch Boolean Determines whether to use a prefix search.

Returns

SnapshotFileConnection!

Sample

query BrowseSnapshotFileConnection($snapshotFid: UUID!, $path: String!) {
  browseSnapshotFileConnection(
    snapshotFid: $snapshotFid
    path: $path
    first: 10
  ) {
    nodes {
      absolutePath
      displayPath
      fileMode
      filename
      lastModified
      path
      size
      statusMessage
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
{
  "snapshotFid": "00000000-0000-0000-0000-000000000000",
  "path": "example-string"
}
{
  "data": {
    "browseSnapshotFileConnection": {
      "nodes": [
        [
          {
            "absolutePath": "example-string",
            "displayPath": "example-string",
            "fileMode": "DIRECTORY",
            "filename": "example-string",
            "lastModified": "2024-01-01T00:00:00.000Z",
            "path": "example-string"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}