InstagramStream - Documentation

Constructor

new InstagramStream(optionsopt)

Create an instance.

Authorization options are passed to underlying Instagram client.

Parameters:

Name Type Attributes Description

options

Object

Instance options.

Properties

Name	Type	Attributes	Description
`client_id`	string	<optional>	Client ID.
`client_secret`	string	<optional>	Client Secret.
`access_token`	string	<optional>	Access token.

Source:

stream.js, line 19

Members

client

Instance of Instagram that serves as underlying source of data.

Source:

stream.js, line 55

isEmpty

true if there is tracks set up, false otherwise.

Source:

stream.js, line 63

Methods

follow(userId) → {InstagramStream}

Follow user.

Parameters:

Name	Type	Description
`userId`	string	User ID.

Source:

stream.js, line 115

Returns:

This instance.

Type: InstagramStream

following() → {Array.<string>}

Get currently tracked users.

Source:

stream.js, line 149

Returns:

List of user IDs.

Type: Array.<string>

setAccessToken(token) → {InstagramStream}

Set access token.

Parameters:

Name	Type	Description
`token`	string	Access token.

Source:

stream.js, line 76

Returns:

This instance.

Type: InstagramStream

track(tag) → {InstagramStream}

Track tag.

Parameters:

Name	Type	Description
`tag`	string	Tag name.

Source:

stream.js, line 89

Returns:

This instance.

Type: InstagramStream

tracking() → {Array.<string>}

Get currently tracked tags.

Source:

stream.js, line 139

Returns:

List of tags.

Type: Array.<string>

unfollow(userId) → {InstagramStream}

Unfollow user.

Parameters:

Name	Type	Description
`userId`	string	User ID.

Source:

stream.js, line 128

Returns:

This instance.

Type: InstagramStream

untrack(tag) → {InstagramStream}

Untrack tag.

Parameters:

Name	Type	Description
`tag`	string	Tag name.

Source:

stream.js, line 102

Returns:

This instance.

Type: InstagramStream