PlainApp
API-Referenz

Tags

Tags sind pro DataType begrenzt (images, audio, video, files, contacts, SMS, calls, notes). Hier Tags und Elementzuordnungen verwalten.

Typdefinitionen

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!
}

Operationen

query

tags

Alle Tags für den angegebenen Datentyp auflisten.

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

tagRelations

Tag-Zuordnungen für einen Satz von Element-Schlüsseln (z. B. Medien-IDs, Notiz-IDs) innerhalb eines Datentyps nachschlagen.

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

createTag

Einen neuen Tag erstellen, der auf einen Datentyp begrenzt ist.

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

updateTag

Einen bestehenden Tag umbenennen.

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

deleteTag

Einen Tag löschen und aus allen getaggten Elementen entfernen.

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

addToTags

Alle auf eine Abfrage passenden Elemente zu einem oder mehreren Tags hinzufügen.

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

updateTagRelations

Tags zu einem einzelnen Element in einem Aufruf hinzufügen und/oder entfernen.

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

removeFromTags

Alle auf eine Abfrage passenden Elemente aus einem oder mehreren Tags entfernen.

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