API 参考
信息源
通过 app.capabilities 判断功能支持,通过 app.access 和宿主权限判断访问授权。示例使用合成数据,调用前请替换路径、ID、输入和筛选条件。
类型定义
graphql
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!
}操作
subscription
feedsFetched
接收信息源同步变更。
graphql
subscription feedsFetched {
feedsFetched { feedId error canceled }
}mutation
createFeed
订阅信息源,并将首次同步加入队列。
graphql
mutation createFeed($url: String!, $fetchContent: Boolean!, $name: String) {
createFeed(url: $url, fetchContent: $fetchContent, name: $name) { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}mutation
deleteFeed
取消订阅信息源,并删除其全部文章及标签关联。
graphql
mutation deleteFeed($id: ID!) {
deleteFeed(id: $id)
}mutation
deleteFeedEntries
删除符合查询条件的订阅文章及标签关联。
graphql
mutation deleteFeedEntries($query: String!) {
deleteFeedEntries(query: $query) { affectedCount }
}mutation
importFeeds
将以字符串提供的 OPML 文档导入订阅数据库。
graphql
mutation importFeeds($content: String!) {
importFeeds(content: $content)
}mutation
markFeedEntriesRead
将匹配的订阅文章标记为已读或未读,并返回受影响数量。
graphql
mutation markFeedEntriesRead($query: String!, $read: Boolean!) {
markFeedEntriesRead(query: $query, read: $read) { affectedCount }
}mutation
syncFeedEntryContent
获取并保存一篇订阅文章的完整内容。
graphql
mutation syncFeedEntryContent($id: ID!) {
syncFeedEntryContent(id: $id) { id title url image description author content feedId }
}mutation
syncFeeds
将指定 ID 的信息源加入同步队列;未传 ID 时同步全部信息源。
graphql
mutation syncFeeds($id: ID) {
syncFeeds(id: $id)
}mutation
updateFeed
更新信息源的显示名称或 fetchContent 标志。
graphql
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 }
}query
exportFeeds
将全部已订阅信息源导出为 OPML 字符串。
graphql
query exportFeeds {
exportFeeds
}query
feed
按 ID 读取订阅信息源;不存在时返回 null。
graphql
query feed($id: ID!) {
feed(id: $id) { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}query
feedEntries
搜索订阅文章的标题和描述;query 留空时列出全部文章。
graphql
query feedEntries($query: String!, $offset: Int!, $limit: Int!) {
feedEntries(query: $query, offset: $offset, limit: $limit) { id title url image description author content feedId }
}query
feedEntry
按 ID 获取一篇订阅文章。
graphql
query feedEntry($id: ID!) {
feedEntry(id: $id) { id title url image description author content feedId }
}query
feedEntryCount
统计符合查询条件的订阅文章数。
graphql
query feedEntryCount($query: String!) {
feedEntryCount(query: $query)
}query
feedEntryCounts
读取订阅文章数量摘要。
graphql
query feedEntryCounts {
feedEntryCounts { feedId count }
}query
feedSyncStates
读取订阅信息源当前的同步状态。
graphql
query feedSyncStates {
feedSyncStates { feedId taskId revision status error }
}query
feeds
列出全部已订阅信息源。
graphql
query feeds {
feeds { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}query
fetchFeedTitle
从 URL 读取订阅源标题,不创建订阅。
graphql
query fetchFeedTitle($url: String!) {
fetchFeedTitle(url: $url)
}