Yesod.Feed

Documentation

newsFeed :: MonadHandler m => Feed (Route (HandlerSite m)) -> m TypedContent

newsFeedText :: MonadHandler m => Feed Text -> m TypedContent

Same as newsFeed but for 'Feed Text'. Useful for cases where you are generating a feed of external links.

data Feed url

The overall feed

Constructors

Feed

Fields

• feedTitle :: Text
• feedLinkSelf :: url
• feedLinkHome :: url
• feedAuthor :: Text
• feedDescription :: Html

  note: currently only used for Rss

• feedLanguage :: Text

  note: currently only used for Rss, possible values: http://www.rssboard.org/rss-language-codes

• feedUpdated :: UTCTime
• feedLogo :: Maybe (url, Text)
• feedEntries :: [FeedEntry url]

data FeedEntry url

Each feed entry

Constructors

FeedEntry

Fields

• feedEntryLink :: url
• feedEntryUpdated :: UTCTime
• feedEntryTitle :: Text
• feedEntryContent :: Html
• feedEntryEnclosure :: Maybe (EntryEnclosure url)

  Allows enclosed data: RSS <enclosure> or Atom <link rel=enclosure>

  Since: 1.5

• feedEntryCategories :: [EntryCategory]

  Allows categories data: RSS <category> or Atom <link term=category>

  Since: 1.7

data EntryEnclosure url

RSS and Atom allow for linked content to be enclosed in a feed entry. This represents the enclosed content.

Atom feeds ignore enclosedSize and enclosedMimeType.

Since: 1.6

Constructors

EntryEnclosure

Fields

• enclosedUrl :: url
• enclosedSize :: Int

  Specified in bytes

• enclosedMimeType :: Text

data EntryCategory

RSS 2.0 and Atom allow category in a feed entry.

• RSS category
• Atom category

RSS feeds ignore categoryLabel

Since: 1.7

Constructors

EntryCategory

Fields

• categoryDomain :: Maybe Text

  category identifier

• categoryLabel :: Maybe Text

  Human-readable label Atom only

• categoryValue :: Text

  identified categorization scheme via URI