com.datasift.client.managedsource.sources

Class Instagram

java.lang.Object

com.datasift.client.managedsource.sources.BaseSource<Instagram>

com.datasift.client.managedsource.sources.Instagram

All Implemented Interfaces:

DataSource<Instagram>

public class Instagram
extends BaseSource<Instagram>

Author:

Courtney Robinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instagram.Type

Nested classes/interfaces inherited from class com.datasift.client.managedsource.sources.BaseSource

BaseSource.AuthParams, BaseSource.ResourceParams

Field Summary

Fields inherited from class com.datasift.client.managedsource.sources.BaseSource

auth, config, log, parameters, resources, type

Constructor Summary

Constructors

Constructor and Description
Instagram(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
Instagram	addOAutToken(String oAuthAccessToken, long expires, String name) Adds an OAuth token to the managed source
protected Instagram	addResource(Instagram.Type type, String value, float longitude, float lattitude, int distance, boolean exactMatch, String fourSquareLocation) Adds a resource object to the request of the given type, which is always required
Instagram	byArea(float longitude, float lattitude)
Instagram	byArea(float longitude, float latitude, int distance) Adds a resource a given area
Instagram	byFoursquareLocation(String fourSquareLocation) The same as byLocation(float, float, int) but instead of using coordinates a foursquare location ID is provided
Instagram	byLocation(float longitude, float latitude)
Instagram	byLocation(float longitude, float latitude, int distance) Adds a resource a given location
Instagram	byPopularity() Adds a resource that is filtered based on popularity
Instagram	byTag(String tag, boolean exactMatch) Adds a resource by tag
Instagram	byUser(String userId) Adds a managed instagram source by user
Instagram	enableComments(boolean enabled) set to true, if you want to receive comment interactions.
Instagram	enableLikes(boolean enabled) set to true, if you want to receive like interactions.

Methods inherited from class com.datasift.client.managedsource.sources.BaseSource

getAuthAsJSON, getParametersAsJSON, getResourcesAsJSON, hasAuth, hasParams, hasResources, newAuthParams, newResourceParams, setParametersField, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Instagram

public Instagram(DataSiftConfig config)

Method Detail

enableLikes

public Instagram enableLikes(boolean enabled)

set to true, if you want to receive like interactions.

Returns:

this

enableComments

public Instagram enableComments(boolean enabled)

set to true, if you want to receive comment interactions.

Returns:

this

byUser

public Instagram byUser(String userId)

Adds a managed instagram source by user

Parameters:

userId - the ID of the user

Returns:

this

byTag

public Instagram byTag(String tag,
              boolean exactMatch)

Adds a resource by tag

Parameters:

tag - the tag, e.g cat

exactMatch - true when a tag must be an exact match or false when the tag should match the instragram tag search behaviour

Returns:

this

byArea

public Instagram byArea(float longitude,
               float lattitude)

byArea

public Instagram byArea(float longitude,
               float latitude,
               int distance)

Adds a resource a given area

Parameters:

longitude - the longitude value of the coordinates to use

latitude - the latitude value of the coordinate to use

distance - an optional distance which marks the radius around the given area, defaults to 1000 and must be between 1 and 5000 metres

Returns:

this

byLocation

public Instagram byLocation(float longitude,
                   float latitude)

byLocation

public Instagram byLocation(float longitude,
                   float latitude,
                   int distance)

Adds a resource a given location

Parameters:

longitude - the longitude value of the coordinates to use

latitude - the latitude value of the coordinate to use

distance - an optional distance which marks the radius around the given area, defaults to 1000 and must be between 1 and 5000 metres

Returns:

this

See Also:

byArea(float, float, int)

byFoursquareLocation

public Instagram byFoursquareLocation(String fourSquareLocation)

The same as byLocation(float, float, int) but instead of using coordinates a foursquare location ID is provided

Parameters:

fourSquareLocation - a valid foursquare location ID e.g. 5XfVJe

Returns:

this

byPopularity

public Instagram byPopularity()

Adds a resource that is filtered based on popularity

Returns:

this

addResource

protected Instagram addResource(Instagram.Type type,
                    String value,
                    float longitude,
                    float lattitude,
                    int distance,
                    boolean exactMatch,
                    String fourSquareLocation)

Adds a resource object to the request of the given type, which is always required

Parameters:

type - the type of resource, all other params are optional dependent upon what this value is

Returns:

this

addOAutToken

public Instagram addOAutToken(String oAuthAccessToken,
                     long expires,
                     String name)

Adds an OAuth token to the managed source

Parameters:

oAuthAccessToken - an oauth2 token

name - a human friendly name for this auth token

expires - identity resource expiry date/time as a UTC timestamp, i.e. when the token expires

Returns:

this