Home Reference Source 
import InstagramApi from 'nodestagram/src/index.js'
public class | source

InstagramApi

Class InstagramApi contains all the methods needed to interact with instagram.

Constructor Summary

Public Constructor
public

constructor(config: {"debug": boolean})

Member Summary

Public Members
public
public
public

jar: *

public

uid: *

public

Method Summary

Public Methods
public

configurePhoto(objectPattern: {"uploadId": *, "captionText": *}): *

public

Method to generate the session to Instagram.
public

postFromFilepath(filepath: *, caption: *): *

public

postFromUrl(url: *, caption: *): *

public

uploadPhoto(source: *, captionText: *, isFilePath: *): Object

Method to create a photo in instagram from a local filepath.

Public Constructors

public constructor(config: {"debug": boolean}) source

Params:

NameTypeAttributeDescription
config {"debug": boolean}
  • optional
  • default: {"debug":false}

Public Members

public deviceId: string source

public endpointUrl: string source

public jar: * source

public uid: * source

public userAgent: * source

Public Methods

public configurePhoto(objectPattern: {"uploadId": *, "captionText": *}): * source

Params:

NameTypeAttributeDescription
objectPattern {"uploadId": *, "captionText": *}
  • default: {"uploadId":null,"captionText":null}

Return:

*

public login(): Object source

Method to generate the session to Instagram.

Return:

Object

Whether or not the promise is fulfilled.

public postFromFilepath(filepath: *, caption: *): * source

Params:

NameTypeAttributeDescription
filepath *
caption *

Return:

*

public postFromUrl(url: *, caption: *): * source

Params:

NameTypeAttributeDescription
url *
caption *

Return:

*

public uploadPhoto(source: *, captionText: *, isFilePath: *): Object source

Method to create a photo in instagram from a local filepath.

Params:

NameTypeAttributeDescription
source *
captionText *
isFilePath *

Return:

Object

Whether or not the promise is fulfilled.