PlainApp
API संदर्भ

Feeds (RSS)

RSS/Atom feeds को सब्सक्राइब करें, entries फेच करें, और articles को नोट्स में सहेजें। OPML import/export का समर्थन करता है।

प्रकार परिभाषाएँ

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

सभी सब्सक्राइब किए गए feeds सूचीबद्ध करें।

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

feedsCount

प्रति-feed कुल और अपठित entry गणना।

bash
query GetFeedsCount {
  feedsCount { feedId count unreadCount }
}
query

feedEntries

feed entries खोजें (शीर्षक + विवरण)। सभी सूचीबद्ध करने के लिए query खाली छोड़ें।

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

किसी query से मेल खाने वाले feed entries की गणना करें।

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

feedEntry

ID द्वारा एकल feed entry फेच करें।

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

createFeed

एक नए feed को सब्सक्राइब करें। सर्वर नाम भरने के लिए RSS चैनल फेच करता है, फिर एक बार का sync शुरू करता है।

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

updateFeed

feed के प्रदर्शन नाम या fetchContent फ़्लैग अपडेट करें।

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

deleteFeed

एक feed को अनसब्सक्राइब करें और इसकी सभी entries (और उनके टैग संबंध) हटाएँ।

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

syncFeeds

एक बार का feed sync worker ट्रिगर करें। एकल feed sync करने के लिए id पास करें; सभी sync करने के लिए null या खाली पास करें।

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

fetchFeedContent

एकल feed entry के लिए पूर्ण article बॉडी फेच करें। अपडेट की गई entry लौटाता है।

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

किसी query से मेल खाने वाली feed entries (और उनके टैग संबंध) हटाएँ।

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

importFeeds

एक OPML दस्तावेज़ (स्ट्रिंग के रूप में) को feeds डेटाबेस में इम्पोर्ट करें।

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

exportFeeds

सभी सब्सक्राइब किए गए feeds को OPML स्ट्रिंग के रूप में निर्यात करें।

bash
mutation ExportFeeds {
  exportFeeds
}