Documents

API リファレンス

Android MediaStore によってインデックスされたドキュメントファイル (PDF、Office、テキストなど) を閲覧します。

型定義

bash

type Doc {
  id: ID!
  title: String!               # filename
  path: String!
  size: Int!                   # bytes
  bucketId: String!            # media store bucket
  createdAt: String!
  updatedAt: String!
  tags: [Tag!]!
}

type DocExtGroup {
  ext: String!                 # file extension without dot, e.g. "pdf"
  count: Int!
}

enum FileSortBy {
  SIZE_ASC SIZE_DESC
  NAME_ASC NAME_DESC
  DATE_ADDED_ASC DATE_ADDED_DESC
  DATE_MODIFIED_ASC DATE_MODIFIED_DESC
}

操作

query

docs

ドキュメントを検索します。クエリを空にするとすべて一覧表示されます。

bash

query GetDocs($offset: Int!, $limit: Int!, $query: String!, $sortBy: FileSortBy!) {
  docs(offset: $offset, limit: $limit, query: $query, sortBy: $sortBy) {
    id title path size bucketId createdAt updatedAt
    tags { id name }
  }
}

query

docCount

クエリに一致するドキュメントの数をカウントします。

bash

query GetDocCount($query: String!) {
  docCount(query: $query)
}

query

docExtGroups

すべての異なるファイル拡張子とその数を一覧表示します。「タイプで絞り込み」UI を構築するのに便利です。

bash

query GetDocExtGroups {
  docExtGroups { ext count }
}