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