API リファレンス

共有

機能の対応状況は app.capabilities、認可は app.access とホストの権限で確認してください。例は合成値を使用しています。呼び出す前にパス、ID、入力、フィルターを置き換えてください。

型定義

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!
}

操作

mutation

createShare

選択したパス、読み取り専用ポリシー、任意の有効期限で共有を作成します。

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

deleteShare

共有を削除し、その共有によるアクセスを失効させます。

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

updateShare

共有の名前、有効期限、選択したファイルシステムルートを更新します。

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

share

型付きパスマッピングと利用可能な URL を含む共有を取得します。存在しない場合は null を返します。

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

shares

編集可能な期限切れの共有も含め、保存済みの共有を一覧表示します。

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