API குறிப்பு

Bookmarks

சுருக்கக்கூடிய குழுக்களுடன் உலாவி-பாணி புக்மார்க்குகளை நிர்வகிக்கவும். புக்மார்க் சேர்க்கப்படும்போது சர்வர் தானாகவே பக்க மெட்டாடேட்டாவை (தலைப்பு) எடுக்கிறது.

வகை வரையறைகள்

bash
type Bookmark {
  id: ID!
  url: String!
  title: String!              # auto-fetched from <title> when available
  groupId: ID!
  pinned: Boolean!
  sortOrder: Int!
  updatedAt: String!
}

type BookmarkGroup {
  id: ID!
  name: String!
  collapsed: Boolean!
  sortOrder: Int!
}

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

செயல்பாடுகள்

query

bookmarks

அனைத்து புக்மார்க்குகளையும் பட்டியலிடவும்.

bash
query GetBookmarks {
  bookmarks { id url title groupId pinned sortOrder updatedAt }
}
query

bookmarkGroups

அனைத்து புக்மார்க் குழுக்களையும் பட்டியலிடவும்.

bash
query GetBookmarkGroups {
  bookmarkGroups { id name collapsed sortOrder }
}
mutation

addBookmarks

ஒரு குழுவிற்கு ஒன்று அல்லது அதற்கு மேற்பட்ட புக்மார்க்குகளைச் சேர்க்கவும். சர்வர் தலைப்பை நிரப்ப ஒவ்வொரு புக்மார்க்கிற்கும் ஒரு மெட்டாடேட்டா-எடுக்கும் நிகழ்வை இயக்குகிறது.

bash
mutation AddBookmarks($urls: [String!]!, $groupId: String!) {
  addBookmarks(urls: $urls, groupId: $groupId) { id url title groupId pinned sortOrder updatedAt }
}
mutation

updateBookmark

ஏற்கனவே உள்ள புக்மார்க்கின் ஒன்று அல்லது அதற்கு மேற்பட்ட புலங்களை புதுப்பிக்கவும்.

bash
mutation UpdateBookmark($id: ID!, $input: BookmarkInput!) {
  updateBookmark(id: $id, input: $input) { id url title groupId pinned sortOrder updatedAt }
}
mutation

deleteBookmarks

ID மூலம் ஒன்று அல்லது அதற்கு மேற்பட்ட புக்மார்க்குகளை நீக்கவும்.

bash
mutation DeleteBookmarks($ids: [ID!]!) {
  deleteBookmarks(ids: $ids)
}
mutation

recordBookmarkClick

ஒரு புக்மார்க்கின் மீதான கிளிக்கைப் பதிவு செய்யவும் (analytics / "most visited" வரிசைப்படுத்தலுக்கு பயன்படுத்தப்படுகிறது).

bash
mutation RecordBookmarkClick($id: ID!) {
  recordBookmarkClick(id: $id)
}
mutation

createBookmarkGroup

ஒரு புதிய புக்மார்க் குழுவை உருவாக்கவும்.

bash
mutation CreateBookmarkGroup($name: String!) {
  createBookmarkGroup(name: $name) { id name collapsed sortOrder }
}
mutation

updateBookmarkGroup

புக்மார்க் குழுவின் பெயர், சுருக்கப்பட்ட நிலை, அல்லது வரிசைப்படுத்தல் வரிசையை புதுப்பிக்கவும்.

bash
mutation UpdateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
  updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) {
    id name collapsed sortOrder
  }
}
mutation

deleteBookmarkGroup

ஒரு புக்மார்க் குழுவை நீக்கவும். உள்ளே உள்ள புக்மார்க்குகள் நீக்கப்படாது, குழுவிலிருந்து மட்டுமே அகற்றப்படும்.

bash
mutation DeleteBookmarkGroup($id: ID!) {
  deleteBookmarkGroup(id: $id)
}