Signets
Vérifier app.capabilities pour la prise en charge des fonctionnalités et app.access ainsi que les permissions de l’hôte pour les autorisations. Les exemples utilisent des valeurs synthétiques ; remplacer les chemins, ID, entrées et filtres avant tout appel.
Définitions de types
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
}Opérations
addBookmarks
Créer des signets pour les URL fournies dans le groupe indiqué.
mutation addBookmarks($urls: [String!]!, $groupId: ID!) {
addBookmarks(urls: $urls, groupId: $groupId) { id url title faviconPath groupId pinned clickCount sortOrder }
}createBookmarkGroup
Créer un groupe de signets.
mutation createBookmarkGroup($name: String!) {
createBookmarkGroup(name: $name) { id name collapsed sortOrder itemCount createdAt updatedAt }
}deleteBookmarkGroup
Supprimer un groupe de signets. Les signets qu’il contient ne sont pas supprimés ; ils ne sont plus regroupés.
mutation deleteBookmarkGroup($id: ID!) {
deleteBookmarkGroup(id: $id)
}deleteBookmarks
Supprimer un ou plusieurs signets par leur ID.
mutation deleteBookmarks($ids: [ID!]!) {
deleteBookmarks(ids: $ids) { affectedCount }
}importBookmarks
Importer des signets à partir du contenu de document fourni et indiquer le nombre d’éléments concernés.
mutation importBookmarks($content: String!) {
importBookmarks(content: $content) { affectedCount }
}recordBookmarkClick
Incrémenter le compteur de visites enregistré d’un signet.
mutation recordBookmarkClick($id: ID!) {
recordBookmarkClick(id: $id)
}updateBookmark
Mettre à jour un ou plusieurs champs d’un signet existant.
mutation updateBookmark($id: ID!, $input: BookmarkInput!) {
updateBookmark(id: $id, input: $input) { id url title faviconPath groupId pinned clickCount sortOrder }
}updateBookmarkGroup
Mettre à jour le nom, l’état replié ou l’ordre de tri d’un groupe de signets.
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 }
}bookmark
Lire un signet enregistré par ID ; renvoyer null s’il est absent.
query bookmark($id: ID!) {
bookmark(id: $id) { id url title faviconPath groupId pinned clickCount sortOrder }
}bookmarkGroups
Lister tous les groupes de signets.
query bookmarkGroups {
bookmarkGroups { id name collapsed sortOrder itemCount createdAt updatedAt }
}bookmarks
Lister tous les signets.
query bookmarks {
bookmarks { id url title faviconPath groupId pinned clickCount sortOrder }
}pageMetadata
Récupérer le titre et l’URL du favicon d’une page web sans enregistrer de signet.
query pageMetadata($url: String!) {
pageMetadata(url: $url) { title faviconUrl }
}bookmarksUpdated
Recevoir les enregistrements de signets mis à jour.
subscription bookmarksUpdated {
bookmarksUpdated { id url title faviconPath groupId pinned clickCount sortOrder }
}