Safe Haskell	None
Language	Haskell98

Instagram

Description

the public API for Instagram access

Synopsis

Documentation

data InstagramT m a Source

the instagram monad transformer this encapsulates the data necessary to pass the app credentials, etc

Instances

MonadTrans InstagramT Source
MonadTransControl InstagramT Source
MonadBaseControl b m => MonadBaseControl b (InstagramT m) Source
MonadBase b m => MonadBase b (InstagramT m) Source
Monad m => Monad (InstagramT m) Source
Functor m => Functor (InstagramT m) Source
MonadFix m => MonadFix (InstagramT m) Source
Applicative m => Applicative (InstagramT m) Source
Alternative m => Alternative (InstagramT m) Source
MonadPlus m => MonadPlus (InstagramT m) Source
MonadThrow m => MonadThrow (InstagramT m) Source
MonadIO m => MonadIO (InstagramT m) Source
MonadResource m => MonadResource (InstagramT m) Source
type StT InstagramT a Source
type StM (InstagramT m) a = ComposeSt InstagramT m a Source

runInstagramT Source

Arguments

:: Credentials	Your app's credentials.
-> Manager	Connection manager (see `withManager`).
-> InstagramT m a	the action to run
-> m a	the result

Run a computation in the InstagramT monad transformer with your credentials.

runResourceInIs :: (MonadResource m, MonadBaseControl IO m) => InstagramT (ResourceT m) a -> InstagramT m a Source

Run a ResourceT inside a InstagramT.

data IGException Source

an exception that a call to instagram may throw

Constructors

JSONException String	JSON parsingError
IGAppException IGError	application exception

Instances

Show IGException Source
Exception IGException Source	make our exception type a normal exception

data IGError Source

an error returned to us by Instagram

Constructors

IGError
Fields igeCode :: Int igeType :: Maybe Text igeMessage :: Maybe Text

Instances

Eq IGError Source
Ord IGError Source
Read IGError Source
Show IGError Source
ToJSON IGError Source	to json as per Instagram format
FromJSON IGError Source	from json as per Instagram format

type RedirectUri = Text Source

the URI to redirect the user after she accepts/refuses to authorize the app

getUserAccessTokenURL1 Source

Arguments

:: Monad m
=> RedirectUri	the URI to redirect the user after she accepts/refuses to authorize the app
-> [Scope]	the requested scopes (can be empty for Basic)
-> InstagramT m Text	the URL to redirect the user to

get the authorize url to redirect your user to

getUserAccessTokenURL2 Source

Arguments

:: (MonadBaseControl IO m, MonadResource m)
=> RedirectUri	the redirect uri
-> Text	the code sent back to your app
-> InstagramT m OAuthToken	the auth token

second step of authorization: get the access token once the user has been redirected with a code

data Credentials Source

the app credentials

Constructors

Credentials
Fields cClientID :: Text client id cClientSecret :: Text client secret

Instances

Eq Credentials Source
Data Credentials Source
Ord Credentials Source
Read Credentials Source
Show Credentials Source

data OAuthToken Source

the oauth token returned after authentication

Constructors

OAuthToken
Fields oaAccessToken :: AccessToken the access token oaUser :: User the user structure returned

Instances

Eq OAuthToken Source
Ord OAuthToken Source
Read OAuthToken Source
Show OAuthToken Source
ToJSON OAuthToken Source	to json as per Instagram format
FromJSON OAuthToken Source	from json as per Instagram format

newtype AccessToken Source

the access token is simply a Text

Constructors

AccessToken Text

Instances

Eq AccessToken Source
Ord AccessToken Source
Read AccessToken Source
Show AccessToken Source
ToJSON AccessToken Source	simple string
FromJSON AccessToken Source	simple string

data User Source

the User partial profile returned by the authentication

Constructors

User
Fields uID :: UserID uUsername :: Text uFullName :: Text uProfilePicture :: Maybe Text uWebsite :: Maybe Text uBio :: Maybe Text uCounts :: Maybe UserCounts

Instances

Eq User Source
Ord User Source
Read User Source
Show User Source
ToJSON User Source	to json as per Instagram format
FromJSON User Source	from json as per Instagram format

data UserCounts Source

the User counts info returned by some endpoints

Constructors

UserCounts
Fields ucMedia :: Int ucFollows :: Int ucFollowedBy :: Int

Instances

Eq UserCounts Source
Ord UserCounts Source
Read UserCounts Source
Show UserCounts Source
ToJSON UserCounts Source	to json as per Instagram format
FromJSON UserCounts Source	from json as per Instagram format

data Scope Source

the scopes of the authentication

Constructors

Basic
Comments
Relationships
Likes

Instances

Bounded Scope Source
Enum Scope Source
Eq Scope Source
Ord Scope Source
Read Scope Source
Show Scope Source

data Envelope d Source

envelope for Instagram OK response

Constructors

Envelope
Fields eMeta :: IGError this should only say 200, no error, but put here for completeness eData :: d data, garanteed to be present (otherwise we get an ErrEnvelope) ePagination :: Maybe Pagination

Instances

Eq d => Eq (Envelope d) Source
Ord d => Ord (Envelope d) Source
Read d => Read (Envelope d) Source
Show d => Show (Envelope d) Source
ToJSON d => ToJSON (Envelope d) Source	to json as per Instagram format
FromJSON d => FromJSON (Envelope d) Source	from json as per Instagram format

getNextPage :: (MonadBaseControl IO m, MonadResource m, FromJSON v) => Envelope v -> InstagramT m (Maybe (Envelope v)) Source

Use the pagination links in an Envelope to fetch the next page of results.

If the Envelope has no pagination, or we have reached the final page (indicated by the pNextUrl field being missing), returns Nothing.

data Pagination Source

pagination info for responses that can return a lot of data

Constructors

Pagination
Fields pNextUrl :: Maybe Text pNextMaxID :: Maybe Text pNextMinID :: Maybe Text pNextMaxTagID :: Maybe Text pMinTagID :: Maybe Text

data Media Source

instagram media object

Constructors

Media

Fields

mID :: MediaID
mCaption :: Maybe Comment
mLink :: Text
mUser :: User
mCreated :: POSIXTime
mImages :: Images
mType :: Text
mUsersInPhoto :: [UserPosition]
mFilter :: Maybe Text
mTags :: [Text]
mLocation :: Maybe Location
mComments :: Collection Comment
mLikes :: Collection User
mUserHasLiked :: Bool
mAttribution :: Maybe Object: seems to be open format https://groups.google.com/forum/?fromgroups#!topic/instagram-api-developers/KvGH1cnjljQ

Instances

Eq Media Source
Show Media Source
ToJSON Media Source	to json as per Instagram format
FromJSON Media Source	from json as per Instagram format

data Position Source

position in picture

Constructors

Position
Fields pX :: Double pY :: Double

Instances

Eq Position Source
Show Position Source
ToJSON Position Source	to json as per Instagram format
FromJSON Position Source	from json as per Instagram format

data UserPosition Source

position of a user

Constructors

UserPosition
Fields upPosition :: Position upUser :: User

Instances

Eq UserPosition Source
Show UserPosition Source
ToJSON UserPosition Source	to json as per Instagram format
FromJSON UserPosition Source	from json as per Instagram format

data Location Source

geographical location info

Constructors

Location
Fields lID :: Maybe LocationID lLatitude :: Maybe Double lLongitude :: Maybe Double lStreetAddress :: Maybe Text lName :: Maybe Text

Instances

Eq Location Source
Ord Location Source
Show Location Source
ToJSON Location Source	to json as per Instagram format
FromJSON Location Source	from json as per Instagram format

data ImageData Source

data for a single image

Constructors

ImageData
Fields idURL :: Text idWidth :: Integer idHeight :: Integer

Instances

Eq ImageData Source
Ord ImageData Source
Show ImageData Source
ToJSON ImageData Source	to json as per Instagram format
FromJSON ImageData Source	from json as per Instagram format

data Images Source

different images for the same media

Constructors

Images
Fields iLowRes :: ImageData iThumbnail :: ImageData iStandardRes :: ImageData

Instances

Eq Images Source
Ord Images Source
Show Images Source
ToJSON Images Source	to json as per Instagram format
FromJSON Images Source	from json as per Instagram format

data Comment Source

Commenton on a medium

Constructors

Comment
Fields cID :: CommentID cCreated :: POSIXTime cText :: Text cFrom :: User

Instances

Eq Comment Source
Ord Comment Source
Show Comment Source
ToJSON Comment Source	to json asCommentstagram format
FromJSON Comment Source	from json asCommentstagram format

data Collection a Source

a collection of items (count + data) data can only be a subset

Constructors

Collection
Fields cCount :: Integer cData :: [a]

Instances

Eq a => Eq (Collection a) Source
Ord a => Ord (Collection a) Source
Show a => Show (Collection a) Source
ToJSON a => ToJSON (Collection a) Source	to json as per Instagram format
FromJSON a => FromJSON (Collection a) Source	from json as per Instagram format

data NoResult Source

Instagram returns data:null for nothing, but Aeson considers that () maps to an empty array... so we model the fact that we expect null via NoResult

Instances

Eq NoResult Source
Ord NoResult Source
Read NoResult Source
Show NoResult Source
ToJSON NoResult Source	to json as per Instagram format
FromJSON NoResult Source	from json as per Instagram format

type UserID = Text Source

User ID

getUser :: (MonadBaseControl IO m, MonadResource m) => UserID -> Maybe OAuthToken -> InstagramT m (Envelope (Maybe User)) Source

Get basic information about a user.

data SelfFeedParams Source

Parameters for call to self feed

Constructors

SelfFeedParams
Fields sfpCount :: Maybe Integer sfpMaxID :: Maybe Text sfpMinId :: Maybe Text

Instances

Show SelfFeedParams Source
Default SelfFeedParams Source
QueryLike SelfFeedParams Source

getSelfFeed :: (MonadBaseControl IO m, MonadResource m) => OAuthToken -> SelfFeedParams -> InstagramT m (Envelope [Media]) Source

See the authenticated user's feed.

data RecentParams Source

Parameters for call to recent media

Constructors

RecentParams
Fields rpCount :: Maybe Integer rpMaxTimestamp :: Maybe POSIXTime rpMinTimestamp :: Maybe POSIXTime rpMaxID :: Maybe Text rpMinId :: Maybe Text

Instances

Show RecentParams Source
Default RecentParams Source
QueryLike RecentParams Source

getRecent :: (MonadBaseControl IO m, MonadResource m) => UserID -> Maybe OAuthToken -> RecentParams -> InstagramT m (Envelope [Media]) Source

Get the most recent media published by a user.

data SelfLikedParams Source

parameters for self liked call

Constructors

SelfLikedParams
Fields slpCount :: Maybe Integer slpMaxLikeID :: Maybe Text

Instances

Show SelfLikedParams Source
Default SelfLikedParams Source
QueryLike SelfLikedParams Source

getSelfLiked :: (MonadBaseControl IO m, MonadResource m) => OAuthToken -> SelfLikedParams -> InstagramT m (Envelope [Media]) Source

See the authenticated user's list of media they've liked.

data UserSearchParams Source

parameters for self liked call

Constructors

UserSearchParams
Fields uspQuery :: Text uspCount :: Maybe Integer

Instances

Show UserSearchParams Source
QueryLike UserSearchParams Source

searchUsers :: (MonadBaseControl IO m, MonadResource m) => Maybe OAuthToken -> UserSearchParams -> InstagramT m (Envelope [User]) Source

Search for a user by name.

data Aspect Source

notification aspect

Instances

Eq Aspect Source
Ord Aspect Source
Read Aspect Source
Show Aspect Source
ToJSON Aspect Source	to json as per Instagram format
FromJSON Aspect Source	from json as per Instagram format

media :: Aspect Source

the media Aspect, the only one supported for now

type CallbackUrl = Text Source

the URL to receive notifications to

data Subscription Source

a subscription to a real time notification

Constructors

Subscription
Fields sID :: Text sType :: Text sObject :: Text sObjectID :: Maybe Text sAspect :: Aspect sCallbackUrl :: CallbackUrl sLatitude :: Maybe Double sLongitude :: Maybe Double sRadius :: Maybe Integer

Instances

Eq Subscription Source
Show Subscription Source
ToJSON Subscription Source	to json as per Instagram format
FromJSON Subscription Source	from json as per Instagram format

createSubscription Source

Arguments

:: (MonadBaseControl IO m, MonadResource m)
=> SubscriptionParams	the subscription parameters
-> InstagramT m (Envelope Subscription)	the created subscription

create a subscription

listSubscriptions Source

Arguments

:: (MonadBaseControl IO m, MonadResource m)
=> InstagramT m (Envelope [Subscription])	the ID of the subscription

list all subscriptions for the application

deleteSubscriptions Source

Arguments

:: (MonadBaseControl IO m, MonadResource m)
=> DeletionParams	the parameters for the deletion
-> InstagramT m (Envelope Value)	the ID of the subscription

delete subscriptions based on criteria

data SubscriptionRequest Source

details of subscription request

Constructors

UserRequest	when a user uploads a picture
TagRequest	when a picture is tagged with the given tag
Fields trTag :: Text
LocationRequest	when a picture is tagged with a specific location
Fields lrID :: Text
GeographyRequest	when a picture is tagged with a location inside the given region
Fields grLatitude :: Double grLongitude :: Double grRadius :: Integer

Instances

Eq SubscriptionRequest Source
Ord SubscriptionRequest Source
Read SubscriptionRequest Source
Show SubscriptionRequest Source
QueryLike SubscriptionRequest Source	to HTTP query

data SubscriptionParams Source

parameters for the subscription creation

Constructors

SubscriptionParams
Fields spRequest :: SubscriptionRequest the actual subscription request spCallback :: CallbackUrl the url Instagram will post notifications to spAspect :: Aspect the subscription aspect spVerifyToken :: Maybe Text the verification token

Instances

Eq SubscriptionParams Source
Ord SubscriptionParams Source
Read SubscriptionParams Source
Show SubscriptionParams Source
QueryLike SubscriptionParams Source	to HTTP query

data DeletionParams Source

deletion parameters

Constructors

DeleteAll	delete all subscriptions
DeleteOne	delete one subscription, given its ID
Fields doID :: Text
DeleteUsers	delete all user subscriptions
DeleteTags	delete all tag subscriptions
DeleteLocations	delete all location subscriptions
DeleteGeographies	delete all geography subscriptions

Instances

Eq DeletionParams Source
Ord DeletionParams Source
Read DeletionParams Source
Show DeletionParams Source
QueryLike DeletionParams Source	to HTTP query

data Update Source

an update from a subscription

Constructors

Update
Fields uSubscriptionID :: Integer uObject :: Text uObjectID :: Text uChangedAspect :: Aspect uTime :: POSIXTime

Instances

Eq Update Source
Show Update Source
ToJSON Update Source	to json as per Instagram format
FromJSON Update Source	from json as per Instagram format

verifySignature Source

Arguments

:: Monad m
=> ByteString	the signature
-> ByteString	the content
-> InstagramT m Bool

verify the signature with the content, using the secret as the key

data Tag Source

a Tag

Constructors

Tag
Fields tName :: TagName tMediaCount :: Integer

Instances

Eq Tag Source
Ord Tag Source
Read Tag Source
Show Tag Source
ToJSON Tag Source	to json as per Instagram format
FromJSON Tag Source	from json as per Instagram format

type TagName = Text Source

Tag Name

getTag :: (MonadBaseControl IO m, MonadResource m) => TagName -> Maybe OAuthToken -> InstagramT m (Envelope (Maybe Tag)) Source

Get information about a tag object.

data RecentTagParams Source

parameters for recent tag pagination

Constructors

RecentTagParams
Fields rtpMaxID :: Maybe Text rtpMinID :: Maybe Text

Instances

Show RecentTagParams Source
Default RecentTagParams Source
QueryLike RecentTagParams Source

getRecentTagged :: (MonadBaseControl IO m, MonadResource m) => TagName -> Maybe OAuthToken -> RecentTagParams -> InstagramT m (Envelope [Media]) Source

Get a list of recently tagged media.

searchTags :: (MonadBaseControl IO m, MonadResource m) => TagName -> Maybe OAuthToken -> InstagramT m (Envelope [Tag]) Source

Search for tags by name.

data OutgoingStatus Source

outgoing relationship status

Constructors

Follows
Requested
OutNone

Instances

Bounded OutgoingStatus Source
Enum OutgoingStatus Source
Eq OutgoingStatus Source
Ord OutgoingStatus Source
Read OutgoingStatus Source
Show OutgoingStatus Source
ToJSON OutgoingStatus Source	to json as per Instagram format
FromJSON OutgoingStatus Source	from json as per Instagram format

data IncomingStatus Source

incoming relationship status

Constructors

FollowedBy
RequestedBy
BlockedByYou
InNone

Instances

Bounded IncomingStatus Source
Enum IncomingStatus Source
Eq IncomingStatus Source
Ord IncomingStatus Source
Read IncomingStatus Source
Show IncomingStatus Source
ToJSON IncomingStatus Source	to json as per Instagram format
FromJSON IncomingStatus Source	from json as per Instagram format

data Relationship Source

a relationship between two users

Constructors

Relationship
Fields rOutgoing :: OutgoingStatus rIncoming :: IncomingStatus rTargetUserPrivate :: Bool not present in doc

Instances

Eq Relationship Source
Ord Relationship Source
Read Relationship Source
Show Relationship Source
ToJSON Relationship Source	to json as per Instagram format
FromJSON Relationship Source	from json as per Instagram format

getFollows :: (MonadBaseControl IO m, MonadResource m) => UserID -> Maybe OAuthToken -> InstagramT m (Envelope [User]) Source

Get the list of users this user follows.

getFollowedBy :: (MonadBaseControl IO m, MonadResource m) => UserID -> Maybe Int -> Maybe OAuthToken -> InstagramT m (Envelope [User]) Source

Get the list of users this user is followed by.

data FollowParams Source

Constructors

FollowParams
Fields fpCount :: Int

Instances

Eq FollowParams Source
Ord FollowParams Source
Read FollowParams Source
Show FollowParams Source
QueryLike FollowParams Source

getFollowsParams :: (MonadBaseControl IO m, MonadResource m) => UserID -> Maybe OAuthToken -> FollowParams -> InstagramT m (Envelope [User]) Source

Get the list of users this user follows.

getFollowedByParams :: (MonadBaseControl IO m, MonadResource m) => UserID -> Maybe OAuthToken -> FollowParams -> InstagramT m (Envelope [User]) Source

Get the list of users this user is followed by.

getRequestedBy :: (MonadBaseControl IO m, MonadResource m) => OAuthToken -> InstagramT m (Envelope [User]) Source

List the users who have requested this user's permission to follow.

getRelationship :: (MonadBaseControl IO m, MonadResource m) => UserID -> OAuthToken -> InstagramT m (Envelope Relationship) Source

Get information about a relationship to another user.

setRelationShip :: (MonadBaseControl IO m, MonadResource m) => UserID -> OAuthToken -> RelationShipAction -> InstagramT m (Envelope (Maybe Relationship)) Source

Modify the relationship between the current user and the target user.

data RelationShipAction Source

relationship action

Constructors

Follow
Unfollow
Block
Unblock
Approve
Deny

type MediaID = Text Source

Media ID

getMedia :: (MonadBaseControl IO m, MonadResource m) => MediaID -> Maybe OAuthToken -> InstagramT m (Envelope (Maybe Media)) Source

Get information about a media object.

Get a list of what media is most popular at the moment.

data MediaSearchParams Source

Parameters for call to media search

Constructors

MediaSearchParams
Fields mspLatitude :: Maybe Double mspLongitude :: Maybe Double mspDistance :: Maybe Integer mspMaxTimestamp :: Maybe POSIXTime mspMinTimestamp :: Maybe POSIXTime

Instances

Show MediaSearchParams Source
Default MediaSearchParams Source
QueryLike MediaSearchParams Source

searchMedia :: (MonadBaseControl IO m, MonadResource m) => Maybe OAuthToken -> MediaSearchParams -> InstagramT m (Envelope [Media]) Source

Search for media in a given area.

type CommentID = Text Source

comment id

getComments :: (MonadBaseControl IO m, MonadResource m) => MediaID -> Maybe OAuthToken -> InstagramT m (Envelope [Comment]) Source

Get a full list of comments on a media.

postComment :: (MonadBaseControl IO m, MonadResource m) => MediaID -> OAuthToken -> Text -> InstagramT m (Envelope NoResult) Source

Create a comment on a media.

deleteComment :: (MonadBaseControl IO m, MonadResource m) => MediaID -> CommentID -> OAuthToken -> InstagramT m (Envelope NoResult) Source

Remove a comment either on the authenticated user's media or authored by the authenticated user.

getLikes :: (MonadBaseControl IO m, MonadResource m) => MediaID -> Maybe OAuthToken -> InstagramT m (Envelope [User]) Source

Get a list of users who have liked this media.

getLikesMaxId :: (MonadBaseControl IO m, MonadResource m) => MediaID -> Maybe UserID -> Maybe OAuthToken -> InstagramT m (Envelope [User]) Source

like :: (MonadBaseControl IO m, MonadResource m) => MediaID -> OAuthToken -> InstagramT m (Envelope NoResult) Source

Set a like on this media by the currently authenticated user.

unlike :: (MonadBaseControl IO m, MonadResource m) => MediaID -> OAuthToken -> InstagramT m (Envelope NoResult) Source

Remove a like on this media by the currently authenticated user.

type LocationID = Text Source

location ID

getLocation :: (MonadBaseControl IO m, MonadResource m) => LocationID -> Maybe OAuthToken -> InstagramT m (Envelope (Maybe Location)) Source

Get information about a location.

data LocationMediaParams Source

Parameters for call to recent media in location search

Constructors

LocationMediaParams
Fields lmspMaxTimestamp :: Maybe POSIXTime lmspMinTimestamp :: Maybe POSIXTime lmspMaxID :: Maybe Text lmspMinId :: Maybe Text

Instances

Show LocationMediaParams Source
Default LocationMediaParams Source
QueryLike LocationMediaParams Source

getLocationRecentMedia :: (MonadBaseControl IO m, MonadResource m) => LocationID -> Maybe OAuthToken -> LocationMediaParams -> InstagramT m (Envelope [Media]) Source

Get a list of recent media objects from a given location.

data LocationSearchParams Source

Parameters for call to media search

Constructors

LocationSearchParams
Fields lspLatitude :: Maybe Double lspLongitude :: Maybe Double lspDistance :: Maybe Integer lspFoursquareIDv2 :: Maybe Text lspFoursquareID :: Maybe Text

Instances

Show LocationSearchParams Source
Default LocationSearchParams Source
QueryLike LocationSearchParams Source

searchLocations :: (MonadBaseControl IO m, MonadResource m) => Maybe OAuthToken -> LocationSearchParams -> InstagramT m (Envelope [Location]) Source

Search for a location by geographic coordinate.

type GeographyID = Text Source

geography ID

data GeographyMediaParams Source

Parameters for call to recent media in geography search

Constructors

GeographyMediaParams
Fields gmpCount :: Maybe Integer gmpMinId :: Maybe Text

Instances

Show GeographyMediaParams Source
Default GeographyMediaParams Source
QueryLike GeographyMediaParams Source

getGeographyRecentMedia :: (MonadBaseControl IO m, MonadResource m) => GeographyID -> GeographyMediaParams -> InstagramT m (Envelope [Media]) Source

Get very recent media from a geography subscription that you created

Eq Pagination Source
Ord Pagination Source
Read Pagination Source
Show Pagination Source
ToJSON Pagination Source	to json as per Instagram format
FromJSON Pagination Source	from json as per Instagram format

Bounded RelationShipAction Source
Enum RelationShipAction Source
Eq RelationShipAction Source
Ord RelationShipAction Source
Read RelationShipAction Source
Show RelationShipAction Source
QueryLike RelationShipAction Source