Liking cljdoc? Tell your friends :D

dk.simongray.podcast.profile.opml

The OPML of a profile: the subscription lists that the listener follows, and the subscriptions as an OPML subscription list, out and in.

A followed list subscribes the listener to the shows that join it, in its folder. The subscription lists are the maps of dk.simongray.podcast.format.opml, which reads and writes the OPML itself.

The OPML of a profile: the subscription lists that the listener follows,
and the subscriptions as an OPML subscription list, out and in.

A followed list subscribes the listener to the shows that join it, in
its folder. The subscription lists are the maps of
dk.simongray.podcast.format.opml, which reads and writes the OPML
itself.
raw docstring

episodes-from-opmlclj/s

(episodes-from-opml profile list id-fn at)

The profile with the progress, the played marks and the deleted episodes that the OPML subscription list holds, as Overcast's extended export writes them, at at.

The id-fn gives the episode id of the media URL of an episode of the feed at a URL, or nil when it doesn't know the episode. An episode that the profile has an entry for stays as it is, and a deleted one is hidden. app.library/episodes-from-opml gives the ids by the feeds of a library.

The `profile` with the progress, the played marks and the deleted
episodes that the OPML subscription `list` holds, as Overcast's extended
export writes them, at `at`.

The `id-fn` gives the episode id of the media URL of an episode of the
feed at a URL, or nil when it doesn't know the episode. An episode that
the profile has an entry for stays as it is, and a deleted one is
hidden. app.library/episodes-from-opml gives the ids by the feeds of a
library.
sourceraw docstring

follow-listclj/s

(follow-list profile url at)
(follow-list profile url {:keys [title folder] :as details} at)

Follow the OPML list at url in profile at at, with the :title and the :folder for its shows in details, when they're given. Following a list again changes its title and folder.

Follow the OPML list at `url` in `profile` at `at`, with the :title and
the :folder for its shows in `details`, when they're given. Following a
list again changes its title and folder.
sourceraw docstring

from-opmlclj/s

(from-opml profile list at)
(from-opml profile list at {:keys [unsubscribed?] :as opts})

Subscribe profile at at to each feed of the OPML subscription list, with opts.

Each subscription gets the title, the innermost folder, the categories as tags and the creation time of its outline. The profile also follows the lists that the OPML includes, and a feed that the profile has already keeps its guid and URL.

A folder around every feed counts as no folder when its name in lower case is one of the :wrappers of opts, a set or a predicate, by default "feeds". An outline with subscribed="0", as Overcast writes for a show that the listener left, is left out unless opts have :unsubscribed? true.

A comment with a guid and no feed URL, as to-opml writes for a show of local files, becomes a subscription without a URL, unless the profile has it. A device with the same files fills it, as their guids agree.

Subscribe `profile` at `at` to each feed of the OPML subscription `list`,
with `opts`.

Each subscription gets the title, the innermost folder, the categories as
tags and the creation time of its outline. The profile also follows the
lists that the OPML includes, and a feed that the profile has already
keeps its guid and URL.

A folder around every feed counts as no folder when its name in lower
case is one of the :wrappers of `opts`, a set or a predicate, by default
"feeds". An outline with subscribed="0", as Overcast writes for a
show that the listener left, is left out unless `opts` have
:unsubscribed? true.

A comment with a guid and no feed URL, as to-opml writes for a show of
local files, becomes a subscription without a URL, unless the profile
has it. A device with the same files fills it, as their guids agree.
sourceraw docstring

listsclj/s

(lists profile)

The OPML lists that the listener follows in profile, as a map from URL to :title and :folder. The folder is the one that the shows of the list go into.

The OPML lists that the listener follows in `profile`, as a map from URL
to :title and :folder. The folder is the one that the shows of the list
go into.
sourceraw docstring

refresh-listclj/s

(refresh-list profile url before after at)

Note in profile at at a new parse after of the OPML list at url, which was before. The result is a map of the new :profile, the feed guids it :added, and those that :left.

Shows that joined the list are subscribed to, in its folder, unless the profile has them already by feed URL or guid. Without before, every show counts as joined. A show that left the list stays a subscription, so that you can ask the listener about it. Nothing changes for a list that the listener doesn't follow.

Note in `profile` at `at` a new parse `after` of the OPML list at `url`,
which was `before`. The result is a map of the new :profile, the feed
guids it :added, and those that :left.

Shows that joined the list are subscribed to, in its folder, unless the
profile has them already by feed URL or guid. Without `before`, every
show counts as joined. A show that left the list stays a subscription,
so that you can ask the listener about it. Nothing changes for a list
that the listener doesn't follow.
sourceraw docstring

to-opmlclj/s

(to-opml profile)
(to-opml profile {:keys [media-url-fn] :as opts})

The live subscriptions of profile as an OPML subscription list.

The folders come first, then the shows in no folder, each in the listener's order, and the followed lists are includes. Each outline has the listener's title of the show as its text, the guid of its feed, the tags as categories, and the time of subscribing as its creation time. A subscription without a URL, e.g. to a show of local files, is one of the :comments instead, which other apps skip, since they have no feed to fetch.

With the :media-url-fn of opts, a function of an episode id that gives the URL of its media or nil, each outline also has the :episodes that the listener played, started or hid, as Overcast's extended export writes them.

The live subscriptions of `profile` as an OPML subscription list.

The folders come first, then the shows in no folder, each in the
listener's order, and the followed lists are includes. Each outline has
the listener's title of the show as its text, the guid of its feed, the
tags as categories, and the time of subscribing as its creation time. A
subscription without a URL, e.g. to a show of local files, is one of the
:comments instead, which other apps skip, since they have no feed to
fetch.

With the :media-url-fn of `opts`, a function of an episode id that
gives the URL of its media or nil, each outline also has the :episodes
that the listener played, started or hid, as Overcast's extended export
writes them.
sourceraw docstring

unfollow-listclj/s

(unfollow-list profile url at)

Stop following the OPML list at url in profile at at, leaving a tombstone. The subscriptions that the list brought stay.

Stop following the OPML list at `url` in `profile` at `at`, leaving a
tombstone. The subscriptions that the list brought stay.
sourceraw docstring

wrappersclj/s

The lower-case names of the folder that some apps write around a whole subscription list. When such a folder holds every feed of the list, it counts as no folder.

The lower-case names of the folder that some apps write around a whole
subscription list. When such a folder holds every feed of the list, it
counts as no folder.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close