API 參考
標籤
透過 app.capabilities 判斷功能支援,透過 app.access 和主機權限判斷存取授權。範例使用合成值;呼叫前請替換路徑、ID、輸入和篩選條件。
型別定義
graphql
type Mutation {
addToTags(type: DataType!, tagIds: [ID!]!, query: String!): Boolean!
createTag(type: DataType!, name: String!): Tag!
deleteTag(id: ID!): Boolean!
removeFromTags(type: DataType!, tagIds: [ID!]!, query: String!): Boolean!
updateTag(id: ID!, name: String!): Tag!
updateTagRelations(type: DataType!, keys: [String!]!, addTagIds: [ID!]!, removeTagIds: [ID!]!): Boolean!
}
type Query {
tagKeys(id: ID!): [String!]!
tagRelations(type: DataType!, keys: [String!]!): [TagRelation!]!
tags(type: DataType!): [Tag!]!
}
enum DataType {
DEFAULT
AUDIO
VIDEO
IMAGE
SMS
CONTACT
NOTE
FEED_ENTRY
CALL
PACKAGE
FILE
APP_FILE
DOC
}
type Tag {
id: ID!
name: String!
type: DataType!
count: Int!
}
type TagRelation {
tagId: ID!
key: String!
}操作
mutation
createTag
建立指定資料類型下的標籤。
graphql
mutation createTag($type: DataType!, $name: String!) {
createTag(type: $type, name: $name) { id name type count }
}mutation
deleteTag
刪除標籤,並移除全部項目與該標籤的關聯。
graphql
mutation deleteTag($id: ID!) {
deleteTag(id: $id)
}mutation
updateTag
重新命名已有標籤。
graphql
mutation updateTag($id: ID!, $name: String!) {
updateTag(id: $id, name: $name) { id name type count }
}mutation
updateTagRelations
在一次呼叫中為單一項目新增和/或移除標籤。
graphql
mutation updateTagRelations($type: DataType!, $keys: [String!]!, $addTagIds: [ID!]!, $removeTagIds: [ID!]!) {
updateTagRelations(type: $type, keys: $keys, addTagIds: $addTagIds, removeTagIds: $removeTagIds)
}query
tagKeys
列出與指定標籤關聯的項目鍵。
graphql
query tagKeys($id: ID!) {
tagKeys(id: $id)
}query
tagRelations
查詢同一資料類型下一組項目鍵(如媒體 ID、筆記 ID)的標籤分配情況。
graphql
query tagRelations($type: DataType!, $keys: [String!]!) {
tagRelations(type: $type, keys: $keys) { tagId key }
}