Feeds (RSS)

API リファレンス

RSS/Atom フィードの購読、エントリの取得、記事のメモへの保存を行います。OPML インポート/エクスポートをサポートします。

型定義

bash

type Feed {
  id: ID!
  url: String!                # RSS/Atom URL
  name: String!               # display name (defaults to feed title)
  fetchContent: Boolean!      # when true, the server fetches the full article body
  updatedAt: String!
}

type FeedCount {
  feedId: ID!
  count: Int!                 # total entries
  unreadCount: Int!
}

type FeedEntry {
  id: ID!
  feedId: ID!
  title: String!
  description: String!        # short summary
  content: String!            # full article body (may be empty until fetched)
  url: String!                # canonical article URL
  publishedAt: String!        # ISO 8601
  read: Boolean!
  favorite: Boolean!
  tags: [Tag!]!
}

操作

query

feeds

購読しているすべてのフィードを一覧表示します。

bash

query GetFeeds {
  feeds { id url name fetchContent updatedAt }
}

query

feedsCount

フィードごとの総エントリ数と未読エントリ数。

bash

query GetFeedsCount {
  feedsCount { feedId count unreadCount }
}

query

feedEntries

フィードエントリを検索します (タイトル + 説明)。クエリを空にするとすべて一覧表示されます。

bash

query GetFeedEntries($offset: Int!, $limit: Int!, $query: String!) {
  feedEntries(offset: $offset, limit: $limit, query: $query) {
    id feedId title description content url publishedAt read favorite
    tags { id name }
  }
}

query

feedEntryCount

クエリに一致するフィードエントリの数をカウントします。

bash

query GetFeedEntryCount($query: String!) {
  feedEntryCount(query: $query)
}

query

feedEntry

ID で単一のフィードエントリを取得します。

bash

query GetFeedEntry($id: ID!) {
  feedEntry(id: $id) { id feedId title description content url publishedAt read favorite }
}

mutation

createFeed

新しいフィードを購読します。サーバーは RSS チャンネルを取得して名前を設定し、その後 1 回限りの同期を開始します。

bash

mutation CreateFeed($url: String!, $fetchContent: Boolean!) {
  createFeed(url: $url, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}

mutation

updateFeed

フィードの表示名または fetchContent フラグを更新します。

bash

mutation UpdateFeed($id: ID!, $name: String!, $fetchContent: Boolean!) {
  updateFeed(id: $id, name: $name, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}

mutation

deleteFeed

フィードの購読を解除し、そのすべてのエントリ (およびそれらのタグ関係) を削除します。

bash

mutation DeleteFeed($id: ID!) {
  deleteFeed(id: $id)
}

mutation

syncFeeds

1 回限りのフィード同期ワーカーをトリガーします。id を渡すと単一フィードを同期、null または空を渡すとすべてを同期します。

bash

mutation SyncFeeds($id: ID) {
  syncFeeds(id: $id)
}

mutation

fetchFeedContent

単一のフィードエントリの完全な記事本文を取得します。更新されたエントリを返します。

bash

mutation FetchFeedContent($id: ID!) {
  fetchFeedContent(id: $id) { id content }
}

mutation

syncFeedContent

fetchFeedContent のエイリアス。後方互換性のために保持されています。

bash

mutation SyncFeedContent($id: ID!) {
  syncFeedContent(id: $id) { id content }
}

mutation

deleteFeedEntries

クエリに一致するフィードエントリ (およびそれらのタグ関係) を削除します。

bash

mutation DeleteFeedEntries($query: String!) {
  deleteFeedEntries(query: $query)
}

mutation

importFeeds

OPML ドキュメント (文字列) をフィードデータベースにインポートします。

bash

mutation ImportFeeds($content: String!) {
  importFeeds(content: $content)
}

mutation

exportFeeds

購読しているすべてのフィードを OPML 文字列としてエクスポートします。

bash

mutation ExportFeeds {
  exportFeeds
}