フィード(RSS)
機能の対応状況は app.capabilities、認可は app.access とホストの権限で確認してください。例は合成値を使用しています。呼び出す前にパス、ID、入力、フィルターを置き換えてください。
型定義
type Subscription {
feedsFetched: FeedSyncChange!
}
type Mutation {
createFeed(url: String!, fetchContent: Boolean!, name: String): Feed!
deleteFeed(id: ID!): Boolean!
deleteFeedEntries(query: String!): ActionResult!
importFeeds(content: String!): Boolean!
markFeedEntriesRead(query: String!, read: Boolean!): ActionResult!
syncFeedEntryContent(id: ID!): FeedEntry!
syncFeeds(id: ID): Boolean!
updateFeed(id: ID!, name: String, fetchContent: Boolean, url: String): Feed!
}
type Query {
exportFeeds: String!
feed(id: ID!): Feed
feedEntries(query: String!, offset: Int!, limit: Int!): [FeedEntry!]!
feedEntry(id: ID!): FeedEntry
feedEntryCount(query: String!): Int!
feedEntryCounts: [FeedEntryCount!]!
feedSyncStates: [FeedSyncState!]!
feeds: [Feed!]!
fetchFeedTitle(url: String!): String!
}
type ActionResult {
affectedCount: Int!
}
enum DataType {
DEFAULT
AUDIO
VIDEO
IMAGE
SMS
CONTACT
NOTE
FEED_ENTRY
CALL
PACKAGE
FILE
APP_FILE
DOC
}
type Feed {
id: ID!
name: String!
url: String!
fetchContent: Boolean!
logo: String!
lastSyncAt: Instant
lastError: FeedError!
createdAt: Instant!
updatedAt: Instant!
}
type FeedEntry {
id: ID!
title: String!
url: String!
image: String!
description: String!
author: String!
content: String!
feedId: ID!
rawId: String!
read: Boolean!
publishedAt: Instant!
createdAt: Instant!
updatedAt: Instant!
tags: [Tag!]!
feed: Feed
}
type FeedEntryCount {
feedId: ID!
count: Int!
}
type FeedError {
code: FeedErrorCode!
detail: String!
}
enum FeedErrorCode {
NONE
TIMEOUT
SERVER
DNS
PARSE
UNKNOWN
}
type FeedSyncChange {
feedId: ID!
error: String
canceled: Boolean
}
type FeedSyncState {
feedId: ID!
taskId: ID!
revision: Long!
status: FeedWorkerStatus!
error: String!
}
enum FeedWorkerStatus {
QUEUED
RUNNING
CANCELED
COMPLETED
ERROR
}
scalar Instant
scalar Long
type Tag {
id: ID!
name: String!
type: DataType!
count: Int!
}操作
feedsFetched
フィードの同期変更を受信します。
subscription feedsFetched {
feedsFetched { feedId error canceled }
}createFeed
フィードを購読し、初回同期をキューに追加します。
mutation createFeed($url: String!, $fetchContent: Boolean!, $name: String) {
createFeed(url: $url, fetchContent: $fetchContent, name: $name) { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}deleteFeed
フィードの購読を解除し、すべての記事とそのタグ関連付けを削除します。
mutation deleteFeed($id: ID!) {
deleteFeed(id: $id)
}deleteFeedEntries
クエリに一致するフィード記事と、そのタグ関連付けを削除します。
mutation deleteFeedEntries($query: String!) {
deleteFeedEntries(query: $query) { affectedCount }
}importFeeds
文字列として渡した OPML ドキュメントをフィードデータベースにインポートします。
mutation importFeeds($content: String!) {
importFeeds(content: $content)
}markFeedEntriesRead
一致するフィード記事を既読または未読にし、影響を受けた件数を報告します。
mutation markFeedEntriesRead($query: String!, $read: Boolean!) {
markFeedEntriesRead(query: $query, read: $read) { affectedCount }
}syncFeedEntryContent
フィード記事 1 件の全文を取得し、保存します。
mutation syncFeedEntryContent($id: ID!) {
syncFeedEntryContent(id: $id) { id title url image description author content feedId }
}syncFeeds
ID を指定して 1 つのフィードの同期をキューに追加します。ID 未指定の場合はすべてのフィードが対象です。
mutation syncFeeds($id: ID) {
syncFeeds(id: $id)
}updateFeed
フィードの表示名または fetchContent フラグを更新します。
mutation updateFeed($id: ID!, $name: String, $fetchContent: Boolean, $url: String) {
updateFeed(id: $id, name: $name, fetchContent: $fetchContent, url: $url) { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}exportFeeds
すべての購読フィードを OPML 文字列としてエクスポートします。
query exportFeeds {
exportFeeds
}feed
ID を指定してフィード購読を 1 件読み取り、存在しない場合は null を返します。
query feed($id: ID!) {
feed(id: $id) { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}feedEntries
フィード記事のタイトルと説明を検索します。すべて表示するには query を空にします。
query feedEntries($query: String!, $offset: Int!, $limit: Int!) {
feedEntries(query: $query, offset: $offset, limit: $limit) { id title url image description author content feedId }
}feedEntry
ID を指定してフィード記事を 1 件取得します。
query feedEntry($id: ID!) {
feedEntry(id: $id) { id title url image description author content feedId }
}feedEntryCount
クエリに一致するフィード記事数を数えます。
query feedEntryCount($query: String!) {
feedEntryCount(query: $query)
}feedEntryCounts
フィード記事数の集計を読み取ります。
query feedEntryCounts {
feedEntryCounts { feedId count }
}feedSyncStates
フィード購読の現在の同期状態を読み取ります。
query feedSyncStates {
feedSyncStates { feedId taskId revision status error }
}feeds
すべての購読フィードを一覧表示します。
query feeds {
feeds { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}fetchFeedTitle
URL からフィードのタイトルを取得します。購読は追加しません。
query fetchFeedTitle($url: String!) {
fetchFeedTitle(url: $url)
}