PlainApp
API リファレンス

Tags

タグは DataType (images、audio、video、files、contacts、SMS、calls、notes) ごとにスコープされます。ここでタグとアイテムの割り当てを管理します。

型定義

bash
type Tag {
  id: ID!
  name: String!
  count: Int!   # total items carrying this tag
}

type TagRelation {
  tagId: ID!
  key: String!  # id of the tagged item
}

# DataType scopes which content type a tag belongs to
enum DataType {
  AUDIO VIDEO IMAGE SMS CONTACT NOTE FEED_ENTRY CALL DOC PACKAGE FILE
}

# Identifies a single item by its ID key, used in updateTagRelations
input TagRelationStub {
  key: String!
}

操作

query

tags

指定したデータ型のすべてのタグを一覧表示します。

bash
query GetTags($type: DataType!) {
  tags(type: $type) { id name count }
}
query

tagRelations

1 つのデータ型内の一連のアイテムキー (例: メディア ID、メモ ID) のタグ割り当てを検索します。

bash
query GetTagRelations($type: DataType!, $keys: [String!]!) {
  tagRelations(type: $type, keys: $keys) {
    tagId
    key
  }
}
mutation

createTag

データ型にスコープされた新しいタグを作成します。

bash
mutation CreateTag($type: DataType!, $name: String!) {
  createTag(type: $type, name: $name) { id name count }
}
mutation

updateTag

既存のタグの名前を変更します。

bash
mutation UpdateTag($id: ID!, $name: String!) {
  updateTag(id: $id, name: $name) { id name }
}
mutation

deleteTag

タグを削除し、タグ付けされたすべてのアイテムから削除します。

bash
mutation DeleteTag($id: ID!) {
  deleteTag(id: $id)
}
mutation

addToTags

クエリに一致するすべてのアイテムを 1 つ以上のタグに追加します。

bash
mutation AddToTags($type: DataType!, $tagIds: [ID!]!, $query: String!) {
  addToTags(type: $type, tagIds: $tagIds, query: $query)
}
mutation

updateTagRelations

1 回の呼び出しで単一アイテムにタグを追加および/または削除します。

bash
mutation UpdateTagRelations($type: DataType!, $item: TagRelationStub!, $addTagIds: [ID!]!, $removeTagIds: [ID!]!) {
  updateTagRelations(type: $type, item: $item, addTagIds: $addTagIds, removeTagIds: $removeTagIds)
}
mutation

removeFromTags

クエリに一致するすべてのアイテムを 1 つ以上のタグから削除します。

bash
mutation RemoveFromTags($type: DataType!, $tagIds: [ID!]!, $query: String!) {
  removeFromTags(type: $type, tagIds: $tagIds, query: $query)
}