PlainApp
API 참조

북마크

기능 지원은 app.capabilities, 인가는 app.access와 호스트 권한으로 확인하세요. 예제는 합성 값을 사용합니다. 호출 전에 경로, ID, 입력, 필터를 바꾸세요.

타입 정의

graphql
type Mutation {
  addBookmarks(urls: [String!]!, groupId: ID!): [Bookmark!]!
  createBookmarkGroup(name: String!): BookmarkGroup!
  deleteBookmarkGroup(id: ID!): Boolean!
  deleteBookmarks(ids: [ID!]!): ActionResult!
  importBookmarks(content: String!): ActionResult!
  recordBookmarkClick(id: ID!): Boolean!
  updateBookmark(id: ID!, input: BookmarkInput!): Bookmark!
  updateBookmarkGroup(id: ID!, name: String!, collapsed: Boolean!, sortOrder: Int!): BookmarkGroup!
}

type Query {
  bookmark(id: ID!): Bookmark
  bookmarkGroups: [BookmarkGroup!]!
  bookmarks: [Bookmark!]!
  pageMetadata(url: String!): PageMetadata!
}

type Subscription {
  bookmarksUpdated: [Bookmark!]!
}

type ActionResult {
	affectedCount: Int!
}

type Bookmark {
	id: ID!
	url: String!
	title: String!
	faviconPath: String!
	groupId: ID!
	pinned: Boolean!
	clickCount: Int!
	sortOrder: Int!
	createdAt: Instant!
	updatedAt: Instant!
	lastClickedAt: Instant
}

type BookmarkGroup {
	id: ID!
	name: String!
	collapsed: Boolean!
	sortOrder: Int!
	itemCount: Int!
	createdAt: Instant!
	updatedAt: Instant!
}

input BookmarkInput {
	url: String!
	title: String!
	
	faviconUrl: String
	groupId: ID!
	pinned: Boolean!
	sortOrder: Int!
}

scalar Instant

type PageMetadata {
	title: String
	faviconUrl: String
}

작업

mutation

addBookmarks

제공된 URL의 북마크를 지정한 그룹에 만듭니다.

graphql
mutation addBookmarks($urls: [String!]!, $groupId: ID!) {
  addBookmarks(urls: $urls, groupId: $groupId) { id url title faviconPath groupId pinned clickCount sortOrder }
}
mutation

createBookmarkGroup

새 북마크 그룹을 만듭니다.

graphql
mutation createBookmarkGroup($name: String!) {
  createBookmarkGroup(name: $name) { id name collapsed sortOrder itemCount createdAt updatedAt }
}
mutation

deleteBookmarkGroup

북마크 그룹을 삭제합니다. 내부 북마크는 삭제하지 않고 그룹에서만 분리합니다.

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

deleteBookmarks

ID로 하나 이상의 북마크를 삭제합니다.

graphql
mutation deleteBookmarks($ids: [ID!]!) {
  deleteBookmarks(ids: $ids) { affectedCount }
}
mutation

importBookmarks

제공된 문서 내용에서 북마크를 가져오고 영향받은 수를 보고합니다.

graphql
mutation importBookmarks($content: String!) {
  importBookmarks(content: $content) { affectedCount }
}
mutation

recordBookmarkClick

북마크에 저장된 방문 횟수를 늘립니다.

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

updateBookmark

기존 북마크의 하나 이상의 필드를 갱신합니다.

graphql
mutation updateBookmark($id: ID!, $input: BookmarkInput!) {
  updateBookmark(id: $id, input: $input) { id url title faviconPath groupId pinned clickCount sortOrder }
}
mutation

updateBookmarkGroup

북마크 그룹의 이름, 접힘 상태, 정렬 순서를 갱신합니다.

graphql
mutation updateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
  updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) { id name collapsed sortOrder itemCount createdAt updatedAt }
}
query

bookmark

ID로 저장된 북마크 하나를 읽고 없으면 null을 반환합니다.

graphql
query bookmark($id: ID!) {
  bookmark(id: $id) { id url title faviconPath groupId pinned clickCount sortOrder }
}
query

bookmarkGroups

모든 북마크 그룹을 나열합니다.

graphql
query bookmarkGroups {
  bookmarkGroups { id name collapsed sortOrder itemCount createdAt updatedAt }
}
query

bookmarks

모든 북마크를 나열합니다.

graphql
query bookmarks {
  bookmarks { id url title faviconPath groupId pinned clickCount sortOrder }
}
query

pageMetadata

북마크를 저장하지 않고 웹 페이지의 제목과 파비콘 URL을 가져옵니다.

graphql
query pageMetadata($url: String!) {
  pageMetadata(url: $url) { title faviconUrl }
}
subscription

bookmarksUpdated

갱신된 북마크 레코드를 받습니다.

graphql
subscription bookmarksUpdated {
  bookmarksUpdated { id url title faviconPath groupId pinned clickCount sortOrder }
}