Copyright | (c) Jon Schoning 2015 |
---|---|
Maintainer | jonschoning@gmail.com |
Stability | experimental |
Portability | POSIX |
Safe Haskell | None |
Language | Haskell2010 |
Provides Pinboard Api Access (deserializes into Haskell data structures)
Synopsis
- getPostsRecent :: MonadPinboard m => Maybe [Tag] -> Maybe Count -> m (Either PinboardError Posts)
- getPostsForDate :: MonadPinboard m => Maybe [Tag] -> Maybe Date -> Maybe Url -> m (Either PinboardError Posts)
- getPostsAll :: MonadPinboard m => Maybe [Tag] -> Maybe StartOffset -> Maybe NumResults -> Maybe FromDateTime -> Maybe ToDateTime -> Maybe Meta -> m (Either PinboardError [Post])
- getPostsDates :: MonadPinboard m => Maybe [Tag] -> m (Either PinboardError PostDates)
- getPostsMRUTime :: MonadPinboard m => m (Either PinboardError UTCTime)
- getSuggestedTags :: MonadPinboard m => Url -> m (Either PinboardError [Suggested])
- addPost :: MonadPinboard m => Url -> Description -> Maybe Extended -> Maybe [Tag] -> Maybe DateTime -> Maybe Replace -> Maybe Shared -> Maybe ToRead -> m (Either PinboardError ())
- addPostRec :: MonadPinboard m => Post -> Replace -> m (Either PinboardError ())
- deletePost :: MonadPinboard m => Url -> m (Either PinboardError ())
- getTags :: MonadPinboard m => m (Either PinboardError TagMap)
- renameTag :: MonadPinboard m => Old -> New -> m (Either PinboardError ())
- deleteTag :: MonadPinboard m => Tag -> m (Either PinboardError ())
- getUserSecretRssKey :: MonadPinboard m => m (Either PinboardError Text)
- getUserApiToken :: MonadPinboard m => m (Either PinboardError Text)
- getNoteList :: MonadPinboard m => m (Either PinboardError NoteList)
- getNote :: MonadPinboard m => NoteId -> m (Either PinboardError Note)
Posts
:: MonadPinboard m | |
=> Maybe [Tag] | filter by up to three tags |
-> Maybe Count | number of results to return. Default is 15, max is 100 |
-> m (Either PinboardError Posts) |
posts/recent : Returns a list of the user's most recent posts, filtered by tag.
:: MonadPinboard m | |
=> Maybe [Tag] | filter by up to three tags |
-> Maybe Date | return results bookmarked on this day |
-> Maybe Url | return bookmark for this URL |
-> m (Either PinboardError Posts) |
posts/get : Returns one or more posts on a single day matching the arguments. If no date or url is given, date of most recent bookmark will be used.
:: MonadPinboard m | |
=> Maybe [Tag] | filter by up to three tags |
-> Maybe StartOffset | offset value (default is 0) |
-> Maybe NumResults | number of results to return. Default is all |
-> Maybe FromDateTime | return only bookmarks created after this time |
-> Maybe ToDateTime | return only bookmarks created before this time |
-> Maybe Meta | include a change detection signature for each bookmark |
-> m (Either PinboardError [Post]) |
posts/all : Returns all bookmarks in the user's account.
:: MonadPinboard m | |
=> Maybe [Tag] | filter by up to three tags |
-> m (Either PinboardError PostDates) |
posts/dates : Returns a list of dates with the number of posts at each date.
getPostsMRUTime :: MonadPinboard m => m (Either PinboardError UTCTime) Source #
posts/update : Returns the most recent time a bookmark was added, updated or deleted.
getSuggestedTags :: MonadPinboard m => Url -> m (Either PinboardError [Suggested]) Source #
posts/suggest : Returns a list of popular tags and recommended tags for a given URL. Popular tags are tags used site-wide for the url; Recommended tags are drawn from the user's own tags.
:: MonadPinboard m | |
=> Url | the URL of the item |
-> Description | Title of the item. This field is unfortunately named |
-> Maybe Extended | Description of the item. Called |
-> Maybe [Tag] | List of up to 100 tags |
-> Maybe DateTime | creation time for this bookmark. Defaults to current time. Datestamps more than 10 minutes ahead of server time will be reset to current server time |
-> Maybe Replace | Replace any existing bookmark with this URL. Default is yes. If set to no, will fail if bookmark exists |
-> Maybe Shared | Make bookmark public. Default is "yes" unless user has enabled the "save all bookmarks as private" user setting, in which case default is "no" |
-> Maybe ToRead | Marks the bookmark as unread. Default is "no" |
-> m (Either PinboardError ()) |
posts/add : Add or Update a bookmark
:: MonadPinboard m | |
=> Post | a Post record |
-> Replace | Replace any existing bookmark with the Posts URL. If set to no, will fail if bookmark exists |
-> m (Either PinboardError ()) |
posts/add : Add or Update a bookmark, from a Post record
deletePost :: MonadPinboard m => Url -> m (Either PinboardError ()) Source #
posts/delete : Delete an existing bookmark.
Tags
getTags :: MonadPinboard m => m (Either PinboardError TagMap) Source #
tags/get : Returns a full list of the user's tags along with the number of times they were used.
:: MonadPinboard m | |
=> Old | note: match is not case sensitive |
-> New | if empty, nothing will happen |
-> m (Either PinboardError ()) |
tags/rename : Rename an tag, or fold it in to an existing tag
deleteTag :: MonadPinboard m => Tag -> m (Either PinboardError ()) Source #
tags/delete : Delete an existing tag.
User
getUserSecretRssKey :: MonadPinboard m => m (Either PinboardError Text) Source #
user/secret : Returns the user's secret RSS key (for viewing private feeds)
getUserApiToken :: MonadPinboard m => m (Either PinboardError Text) Source #
user/api_token : Returns the user's API token (for making API calls without a password)
Notes
getNoteList :: MonadPinboard m => m (Either PinboardError NoteList) Source #
notes/list : Returns a list of the user's notes (note text detail is not included)
getNote :: MonadPinboard m => NoteId -> m (Either PinboardError Note) Source #
notes/id : Returns an individual user note. The hash property is a 20 character long sha1 hash of the note text.