PlainApp
API குறிப்பு

Feeds (RSS)

RSS/Atom feeds-க்கு குழுசேரவும், entries எடுக்கவும், மற்றும் கட்டுரைகளை குறிப்புகளாக சேமிக்கவும். 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

syncFeedEntryContent

Fetch the full article body for a single feed entry. Returns the updated entry.

bash
mutation SyncFeedEntryContent($id: ID!) {
  syncFeedEntryContent(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
}