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
MonadTransControl InstagramT
MonadBaseControl b m => MonadBaseControl b (InstagramT m)
MonadBase b m => MonadBase b (InstagramT m)
Alternative m => Alternative (InstagramT m)
Monad m => Monad (InstagramT m)
Functor m => Functor (InstagramT m)
MonadFix m => MonadFix (InstagramT m)
MonadPlus m => MonadPlus (InstagramT m)
Applicative m => Applicative (InstagramT m)
MonadThrow m => MonadThrow (InstagramT m)
MonadIO m => MonadIO (InstagramT m)
MonadResource m => MonadResource (InstagramT m)
type StT InstagramT a
type StM (InstagramT m) a = ComposeSt InstagramT m a

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

Instances

Show IGException
Exception IGException	make our exception type a normal exception
Typeable * IGException

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
Ord Credentials
Read Credentials
Show Credentials
Typeable * Credentials

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
Ord OAuthToken
Read OAuthToken
Show OAuthToken
ToJSON OAuthToken	to json as per Instagram format
FromJSON OAuthToken	from json as per Instagram format
Typeable * OAuthToken

newtype AccessToken Source

the access token is simply a Text

Constructors

AccessToken Text

Instances

Eq AccessToken
Ord AccessToken
Read AccessToken
Show AccessToken
ToJSON AccessToken	simple string
FromJSON AccessToken	simple string
Typeable * AccessToken

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
Ord User
Read User
Show User
ToJSON User	to json as per Instagram format
FromJSON User	from json as per Instagram format
Typeable * User

data UserCounts Source

the User counts info returned by some endpoints

Constructors

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

Instances

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

data Scope Source

the scopes of the authentication

Constructors

Basic
Comments
Relationships
Likes

Instances

Bounded Scope
Enum Scope
Eq Scope
Ord Scope
Read Scope
Show Scope
Typeable * Scope

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)
Ord d => Ord (Envelope d)
Read d => Read (Envelope d)
Show d => Show (Envelope d)
ToJSON d => ToJSON (Envelope d)	to json as per Instagram format
FromJSON d => FromJSON (Envelope d)	from json as per Instagram format
Typeable (* -> *) Envelope

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
Show Media
ToJSON Media	to json as per Instagram format
FromJSON Media	from json as per Instagram format
Typeable * Media

data Position Source

position in picture

Constructors

Position
Fields pX :: Double pY :: Double

Instances

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

data UserPosition Source

position of a user

Constructors

UserPosition
Fields upPosition :: Position upUser :: User

Instances

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

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
Ord Location
Show Location
ToJSON Location	to json as per Instagram format
FromJSON Location	from json as per Instagram format
Typeable * Location

data ImageData Source

data for a single image

Constructors

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

Instances

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

data Images Source

different images for the same media

Constructors

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

Instances

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

data Comment Source

Commenton on a medium

Constructors

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

Instances

Eq Comment
Ord Comment
Show Comment
ToJSON Comment	to json asCommentstagram format
FromJSON Comment	from json asCommentstagram format
Typeable * Comment

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)
Ord a => Ord (Collection a)
Show a => Show (Collection a)
ToJSON a => ToJSON (Collection a)	to json as per Instagram format
FromJSON a => FromJSON (Collection a)	from json as per Instagram format
Typeable (* -> *) Collection

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
Ord NoResult
Read NoResult
Show NoResult
ToJSON NoResult	to json as per Instagram format
FromJSON NoResult	from json as per Instagram format
Typeable * NoResult

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
Default SelfFeedParams
QueryLike SelfFeedParams
Typeable * SelfFeedParams

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
Default RecentParams
QueryLike RecentParams
Typeable * RecentParams

getRecent :: (MonadBaseControl IO m, MonadResource m) => UserID -> 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
Default SelfLikedParams
QueryLike SelfLikedParams
Typeable * SelfLikedParams

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
QueryLike UserSearchParams
Typeable * UserSearchParams

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
Ord Aspect
Read Aspect
Show Aspect
ToJSON Aspect	to json as per Instagram format
FromJSON Aspect	from json as per Instagram format
Typeable * Aspect

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
Show Subscription
ToJSON Subscription	to json as per Instagram format
FromJSON Subscription	from json as per Instagram format
Typeable * Subscription

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
Ord SubscriptionRequest
Read SubscriptionRequest
Show SubscriptionRequest
QueryLike SubscriptionRequest	to HTTP query
Typeable * SubscriptionRequest

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
Ord SubscriptionParams
Read SubscriptionParams
Show SubscriptionParams
QueryLike SubscriptionParams	to HTTP query
Typeable * SubscriptionParams

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
Ord DeletionParams
Read DeletionParams
Show DeletionParams
QueryLike DeletionParams	to HTTP query
Typeable * DeletionParams

data Update Source

an update from a subscription

Constructors

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

Instances

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

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
Ord Tag
Read Tag
Show Tag
ToJSON Tag	to json as per Instagram format
FromJSON Tag	from json as per Instagram format
Typeable * Tag

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
Default RecentTagParams
QueryLike RecentTagParams
Typeable * RecentTagParams

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
Enum OutgoingStatus
Eq OutgoingStatus
Ord OutgoingStatus
Read OutgoingStatus
Show OutgoingStatus
ToJSON OutgoingStatus	to json as per Instagram format
FromJSON OutgoingStatus	from json as per Instagram format
Typeable * OutgoingStatus

data IncomingStatus Source

incoming relationship status

Constructors

FollowedBy
RequestedBy
BlockedByYou
InNone

Instances

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

data Relationship Source

a relationship between two users

Constructors

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

Instances

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

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 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
Ord FollowParams
Read FollowParams
Show FollowParams
QueryLike FollowParams

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

Instances

Bounded RelationShipAction
Enum RelationShipAction
Eq RelationShipAction
Ord RelationShipAction
Read RelationShipAction
Show RelationShipAction
QueryLike RelationShipAction
Typeable * RelationShipAction

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
Default MediaSearchParams
QueryLike MediaSearchParams
Typeable * MediaSearchParams

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.

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
Default LocationMediaParams
QueryLike LocationMediaParams
Typeable * LocationMediaParams

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
Default LocationSearchParams
QueryLike LocationSearchParams
Typeable * LocationSearchParams

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
Default GeographyMediaParams
QueryLike GeographyMediaParams
Typeable * GeographyMediaParams

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
Ord Pagination
Read Pagination
Show Pagination
ToJSON Pagination	to json as per Instagram format
FromJSON Pagination	from json as per Instagram format
Typeable * Pagination