PlainApp
Referência da API

Favoritos

Verificar app.capabilities para o suporte de funcionalidades e app.access juntamente com as permissões do anfitrião para autorização. Os exemplos usam valores sintéticos; substituir caminhos, ID, entradas e filtros antes da chamada.

Definições de Tipo

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
}

Operações

mutation

addBookmarks

Criar marcadores para os URL fornecidos no grupo indicado.

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

createBookmarkGroup

Criar um grupo de marcadores.

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

deleteBookmarkGroup

Eliminar um grupo de marcadores. Os marcadores contidos não são eliminados, apenas deixam de estar agrupados.

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

deleteBookmarks

Eliminar um ou mais marcadores pelo ID.

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

importBookmarks

Importar marcadores do conteúdo de documento fornecido e indicar a contagem afetada.

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

recordBookmarkClick

Incrementar a contagem de visitas guardada de um marcador.

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

updateBookmark

Atualizar um ou mais campos de um marcador existente.

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

updateBookmarkGroup

Atualizar o nome, estado recolhido ou ordem de um grupo de marcadores.

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

Consultar um marcador guardado pelo ID; devolver null se não existir.

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

bookmarkGroups

Listar todos os grupos de marcadores.

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

bookmarks

Listar todos os marcadores.

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

pageMetadata

Obter o título e o URL do favicon de uma página Web sem guardar um marcador.

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

bookmarksUpdated

Receber os registos de marcadores atualizados.

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