reader

package
v0.92.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2026 License: GPL-3.0 Imports: 6 Imported by: 0

Documentation

Overview

Package reader implements the RSS/feed reading capability.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Descriptor

func Descriptor(backend, app string, svc Service) hub.Descriptor

func RegisterService

func RegisterService(backend, app string, svc Service) error

RegisterService registers the reader capability with the hub and ability registry. It returns nil and logs a warning when svc is nil (provider not configured).

Types

type EntryQuery

type EntryQuery struct {
	Page   ability.PageRequest
	Status string
	FeedID int64
}

type FeedQuery

type FeedQuery struct {
	Page ability.PageRequest
}

type Service

type Service interface {
	ListFeeds(ctx context.Context, q *FeedQuery) (*ability.ListResult[ability.Feed], error)
	CreateFeed(ctx context.Context, feedURL string) (*ability.Feed, error)
	ListEntries(ctx context.Context, q *EntryQuery) (*ability.ListResult[ability.Entry], error)
	MarkEntryRead(ctx context.Context, id int64) error
	MarkEntryUnread(ctx context.Context, id int64) error
	StarEntry(ctx context.Context, id int64) error
	UnstarEntry(ctx context.Context, id int64) error
}

Directories

Path Synopsis
Package miniflux implements the Miniflux adapter for the reader capability.
Package miniflux implements the Miniflux adapter for the reader capability.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL