PlainApp
API குறிப்பு

புத்தகக்குறிகள்

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், 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

புத்தகக்குறியைச் சேமிக்காமல் இணையப் பக்கத்தின் தலைப்பையும் favicon 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 }
}