Référence de l'API

Flux (RSS)

Vérifier app.capabilities pour la prise en charge des fonctionnalités et app.access ainsi que les permissions de l’hôte pour les autorisations. Les exemples utilisent des valeurs synthétiques ; remplacer les chemins, ID, entrées et filtres avant tout appel.

Définitions de types

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

Opérations

subscription

feedsFetched

Recevoir les changements de synchronisation des flux.

graphql
subscription feedsFetched {
  feedsFetched { feedId error canceled }
}
mutation

createFeed

S’abonner à un flux et mettre sa synchronisation initiale en file d’attente.

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

Se désabonner d’un flux et supprimer tous ses articles (et leurs associations aux étiquettes).

graphql
mutation deleteFeed($id: ID!) {
  deleteFeed(id: $id)
}
mutation

deleteFeedEntries

Supprimer les articles de flux correspondant à une requête (et leurs associations aux étiquettes).

graphql
mutation deleteFeedEntries($query: String!) {
  deleteFeedEntries(query: $query) { affectedCount }
}
mutation

importFeeds

Importer un document OPML (sous forme de chaîne) dans la base de données des flux.

graphql
mutation importFeeds($content: String!) {
  importFeeds(content: $content)
}
mutation

markFeedEntriesRead

Marquer les articles de flux correspondants comme lus ou non lus et indiquer le nombre d’éléments concernés.

graphql
mutation markFeedEntriesRead($query: String!, $read: Boolean!) {
  markFeedEntriesRead(query: $query, read: $read) { affectedCount }
}
mutation

syncFeedEntryContent

Récupérer et enregistrer le contenu complet d’un article de flux.

graphql
mutation syncFeedEntryContent($id: ID!) {
  syncFeedEntryContent(id: $id) { id title url image description author content feedId }
}
mutation

syncFeeds

Mettre en file d’attente la synchronisation d’un flux par ID, ou de tous les flux si aucun ID n’est fourni.

graphql
mutation syncFeeds($id: ID) {
  syncFeeds(id: $id)
}
mutation

updateFeed

Mettre à jour le nom affiché d’un flux ou son indicateur 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

Exporter tous les flux suivis sous forme de chaîne OPML.

graphql
query exportFeeds {
  exportFeeds
}
query

feed

Lire un abonnement à un flux par ID ; renvoyer null s’il est absent.

graphql
query feed($id: ID!) {
  feed(id: $id) { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}
query

feedEntries

Rechercher des articles de flux (titre + description). Laisser query vide pour tous les lister.

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

Obtenir un article de flux par son ID.

graphql
query feedEntry($id: ID!) {
  feedEntry(id: $id) { id title url image description author content feedId }
}
query

feedEntryCount

Compter les articles de flux correspondant à une requête.

graphql
query feedEntryCount($query: String!) {
  feedEntryCount(query: $query)
}
query

feedEntryCounts

Lire les résumés du nombre d’articles des flux.

graphql
query feedEntryCounts {
  feedEntryCounts { feedId count }
}
query

feedSyncStates

Lire l’état actuel de synchronisation des abonnements aux flux.

graphql
query feedSyncStates {
  feedSyncStates { feedId taskId revision status error }
}
query

feeds

Lister tous les flux suivis.

graphql
query feeds {
  feeds { id name url fetchContent logo lastSyncAt createdAt updatedAt }
}
query

fetchFeedTitle

Récupère le titre du flux depuis son URL sans ajouter d’abonnement.

graphql
query fetchFeedTitle($url: String!) {
  fetchFeedTitle(url: $url)
}