Pocketex.Item

Wrapper functions for working with items (articles, images, videos) through the Pocket API

Summary

add_tags(options)
add_tags(auth, options)
add_tags(consumer_key, access_token, item_id, tags)

Adds tags to an item

archive(options)
archive(auth, options)
archive(consumer_key, access_token, item_id)

Archive item

clear_tags(options)
clear_tags(auth, options)
clear_tags(consumer_key, access_token, item_id)

Removes all tags from item

create(options)
create(auth, options)
create(consumer_key, access_token, options)

Adds item to Pocket

delete(options)
delete(auth, options)
delete(consumer_key, access_token, item_id)

Delete item

fav(options)
fav(auth, options)
fav(consumer_key, access_token, item_id)

Adds item to favorites

get(options)
get(auth, options)
get(consumer_key, access_token, options)

Gets items from the Pocket API, based on the optional parameters The optional parameters can be sent in Elixir formatting (underscores) instead of Pocket’s bumpy case

remove_tags(options)
remove_tags(auth, options)
remove_tags(consumer_key, access_token, item_id, tags)

Removes tags from an item

rename_tag(options)
rename_tag(auth, options)
rename_tag(consumer_key, access_token, item_id, options)

Ranames tag — affects all items with this tag

replace_tags(options)
replace_tags(auth, options)
replace_tags(consumer_key, access_token, item_id, tags)

Replaces tags for an item

unarchive(options)
unarchive(auth, options)
unarchive(consumer_key, access_token, item_id)

Unarchive item

unfav(options)
unfav(auth, options)
unfav(consumer_key, access_token, item_id)

Remove item from favorites

Functions

add_tags(options)
add_tags(auth, options)
add_tags(consumer_key, access_token, item_id, tags)

Adds tags to an item

archive(options)
archive(auth, options)
archive(consumer_key, access_token, item_id)

Archive item

clear_tags(options)
clear_tags(auth, options)
clear_tags(consumer_key, access_token, item_id)

Removes all tags from item

create(options)
create(auth, options)
create(consumer_key, access_token, options)

Adds item to Pocket

delete(options)
delete(auth, options)
delete(consumer_key, access_token, item_id)

Delete item

fav(options)
fav(auth, options)
fav(consumer_key, access_token, item_id)

Adds item to favorites

get(options)
get(auth, options)
get(consumer_key, access_token, options)

Gets items from the Pocket API, based on the optional parameters The optional parameters can be sent in Elixir formatting (underscores) instead of Pocket’s bumpy case

Optional Parameters state string See below for valid values favorite 0 or 1 See below for valid values tag string See below for valid values contentType string See below for valid values sort string See below for valid values detailType string See below for valid values search string Only return items whose title or url contain the search string domain string Only return items from a particular domain since timestamp Only return items modified since the given since unix timestamp count integer Only return count number of items offset integer Used only with count; start returning from offset position of results

state unread = only return unread items (default) archive = only return archived items all = return both unread and archived items

favorite 0 = only return un-favorited items 1 = only return favorited items

tag tagname = only return items tagged with tag_name _untagged = only return untagged items

contentType article = only return articles video = only return videos or articles with embedded videos image = only return images

sort newest = return items in order of newest to oldest oldest = return items in order of oldest to newest title = return items in order of title alphabetically site = return items in order of url alphabetically

detailType simple = only return the titles and urls of each item complete = return all data about each item, including tags, images, authors, videos and more

remove_tags(options)
remove_tags(auth, options)
remove_tags(consumer_key, access_token, item_id, tags)

Removes tags from an item

rename_tag(options)
rename_tag(auth, options)
rename_tag(consumer_key, access_token, item_id, options)

Ranames tag — affects all items with this tag

replace_tags(options)
replace_tags(auth, options)
replace_tags(consumer_key, access_token, item_id, tags)

Replaces tags for an item

unarchive(options)
unarchive(auth, options)
unarchive(consumer_key, access_token, item_id)

Unarchive item

unfav(options)
unfav(auth, options)
unfav(consumer_key, access_token, item_id)

Remove item from favorites