API-Referenz

Freigaben

Funktionsunterstützung über app.capabilities prüfen, Autorisierung über app.access und Host-Berechtigungen. Die Beispiele verwenden synthetische Werte; vor dem Aufruf Pfade, IDs, Eingaben und Filter ersetzen.

Typdefinitionen

graphql
type Mutation {
  createShare(input: ShareInput!): Share!
  deleteShare(id: ID!): Boolean!
  updateShare(id: ID!, input: ShareInput!): Share!
}

type Query {
  share(id: ID!): Share
  shares: [Share!]!
}

scalar Instant

type Share {
	id: ID!
	name: String!
	password: String!
	expiresAt: Instant
	readOnly: Boolean!
	data: [SharePath!]!
	url: String!
}

input ShareInput {
	name: String!
	password: String!
	expiresAt: Instant
	readOnly: Boolean!
	data: [SharePathInput!]!
}

type SharePath {
	virtualPath: String!
	realPath: String!
	isDir: Boolean!
}

input SharePathInput {
	virtualPath: String!
	realPath: String!
	isDir: Boolean!
}

Operationen

mutation

createShare

Erstellt eine Freigabe für die gewählten Pfade mit Schreibschutzrichtlinie und optionaler Ablaufzeit.

graphql
mutation createShare($input: ShareInput!) {
  createShare(input: $input) { id name password expiresAt readOnly url }
}
mutation

deleteShare

Löscht eine Freigabe und widerruft den darüber gewährten Zugriff.

graphql
mutation deleteShare($id: ID!) {
  deleteShare(id: $id)
}
mutation

updateShare

Aktualisiert Name, Ablaufzeit oder ausgewählte Dateisystemwurzeln einer Freigabe.

graphql
mutation updateShare($id: ID!, $input: ShareInput!) {
  updateShare(id: $id, input: $input) { id name password expiresAt readOnly url }
}
query

share

Eine Freigabe mit typisierten Pfadzuordnungen und nutzbarer URL lesen; bei Fehlen null zurückgeben.

graphql
query share($id: ID!) {
  share(id: $id) { id name password expiresAt readOnly url }
}
query

shares

Gespeicherte Freigaben einschließlich weiterhin bearbeitbarer abgelaufener Freigaben auflisten.

graphql
query shares {
  shares { id name password expiresAt readOnly url }
}