greader

Documentation

Index

• func UnescapeAPIString(s string) string
• type Client
  • func New(baseURL, login, password string) *Client
  • func (c *Client) ListSubscriptions(ctx context.Context) ([]Subscription, error)
  • func (c *Client) MarkAllRead(ctx context.Context, streamID string) error
  • func (c *Client) MarkEntryRead(ctx context.Context, itemID string, read bool) error
  • func (c *Client) QuickAdd(ctx context.Context, feedURL string) (QuickAddResult, error)
  • func (c *Client) StreamContents(ctx context.Context, streamID string, limit int) ([]Entry, error)
  • func (c *Client) UnreadCounts(ctx context.Context) (map[string]int64, error)
• type Entry
• type QuickAddResult
• type Subscription

Functions

func UnescapeAPIString

func UnescapeAPIString(s string) string

UnescapeAPIString decodes HTML entities in text from the Reader API (e.g. ' → '). It runs multiple passes so double-encoded values (e.g. ') become a single apostrophe. A final literal pass catches refs that still appear verbatim in some JSON/XML pipelines.

Types

type Client

type Client struct {
	BaseURL    string
	Login      string
	Password   string
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

Client speaks the Google Reader-compatible API used by FreshRSS and similar servers. -allie

func New

func New(baseURL, login, password string) *Client

func (*Client) ListSubscriptions

func (c *Client) ListSubscriptions(ctx context.Context) ([]Subscription, error)

func (*Client) MarkAllRead

func (c *Client) MarkAllRead(ctx context.Context, streamID string) error

func (*Client) MarkEntryRead

func (c *Client) MarkEntryRead(ctx context.Context, itemID string, read bool) error

func (*Client) QuickAdd

func (c *Client) QuickAdd(ctx context.Context, feedURL string) (QuickAddResult, error)

func (*Client) StreamContents

func (c *Client) StreamContents(ctx context.Context, streamID string, limit int) ([]Entry, error)

func (*Client) UnreadCounts

func (c *Client) UnreadCounts(ctx context.Context) (map[string]int64, error)

type Entry

type Entry struct {
	ID          string
	StreamID    string
	Title       string
	Link        string
	ContentHTML string
	PublishedAt time.Time
	Read        bool
}

Entry is a remote article after Reader API fields are normalized for Tide. -allie

type QuickAddResult

type QuickAddResult struct {
	Query      string
	StreamID   string
	StreamName string
}

QuickAddResult captures the stream identity returned when a server subscribes to a feed URL. -allie

type Subscription

type Subscription struct {
	ID       string
	Title    string
	FeedURL  string
	HTMLURL  string
	Category string
}

Subscription is the remote feed shape Tide imports into its local sidebar model. -allie