Pocketeer

v0.1.5

Pocketeer v0.1.5 Pocketeer.Get

Builds structs for use with the Retrieve endpoint of the Pocket API.

Summary

Types

contentType()
count()
detailType()
domain()
favorite()
offset()
search()
since()
sort()
state()
t()

A map of properties that can be used with Pocketeer.get/2

tag()

Functions

new(opts)

Builds a new Get struct using the opts provided. It handles all allowed values for the Retrieve API endpoint

Types 

contentType :: :article | :video | :image
count :: number
detailType :: :simple | :complete
domain :: binary
favorite :: true | false
offset :: number
search :: binary
since :: number
sort :: :newest | :oldest | :title | :site
state :: :unread | :archive | :all
t :: %Pocketeer.Get{contentType: contentType, count: count, detailType: detailType, domain: domain, favorite: favorite, offset: offset, search: search, since: since, sort: sort, state: state, tag: tag}

A map of properties that can be used with Pocketeer.get/2.

tag :: binary | :untagged

Functions

new(opts)

Specs

new(map) :: t

Builds a new Get struct using the opts provided. It handles all allowed values for the Retrieve API endpoint.

Parameters

Builds a parameters strucht to get items from the Pocket API. This struct accepts a list of options that define how items are fetched. The struct can be given as parameter to Pocketeer.get.

:state - the state of the articles.

  • :unread - only return unread articles (default)
  • :archive - only return archived articles
  • :all - return both unread and archived articles

:favorite - when not given returns all

  • true - return favorited articles only
  • false - return non-favorited articles only

:tag - a tag to return items

  • tag_name - only returns articles with the tag
  • untagged - return articles that have no tag at all

:contentType - the content type of the articles

  • :article - only return articles
  • :video - only return videos or articles with embedded videos
  • :image - only return images

:sort - sorting method in which returned articles are ordered

  • :newest - orders items from recent to oldest
  • :oldest - orders items from oldest to recent
  • :title - orders items by title in alphabetical order
  • :site - orders items by url in alphabetical order

:detailType - defines detail of result

  • :simple - only return titles and urls of items
  • :complete - return full data for each item

:search - when given return only items that where the title or url matches the string

:domain - when given only return items from a particular domain

:since - when given returns items that were modified after the given unix timestamp

:count - when given sets the number of items to return

:offset - when given defines the offset position of results, works only in combination with :count