API संदर्भ

फ़ीड (RSS)

सुविधा समर्थन के लिए 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)
}