Class Client

A client that creating requests.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.2.0

Hierarchy

Client

Index

Constructors

constructor

new Client(accessToken: string, pageId: string, apiVersion?: ApiVersion): Client
The constructor.
Parameters
- accessToken: string
  
  the access token.
- pageId: string
  
  The id of the page.
- Optional apiVersion: ApiVersion
  
  the API version
Returns Client
- Defined in main/Client.ts:78

Properties

`Private` `Readonly` accessToken

accessToken: string

The API access token.

`Private` `Optional` `Readonly` apiVersion

apiVersion?: ApiVersion

The API version to use on requests.

`Private` `Readonly` pageId

pageId: string

The id of the page. This is used on page related requests, so it should be the page for which the access token has permissions.

Methods

getAccessToken

getAccessToken(): string
Gets the access token.

Returns
the access token.

Returns string
- Defined in main/Client.ts:89

getPageId

getPageId(): string
Gets the page id.

Returns
the page id.

Returns string
- Defined in main/Client.ts:98

newDeleteCommentRequest

newDeleteCommentRequest(commentId: string): DeleteCommentRequest
Builds a new DeleteCommentRequest.

Returns
a new DeleteCommentRequest.
Parameters
- commentId: string
  
  the comment id.
Returns DeleteCommentRequest
- Defined in main/Client.ts:331

newGetCommentRequest

newGetCommentRequest(commentId: string, ...fields: CommentField[]): GetCommentRequest
Builds a new GetCommentRequest.

Returns
a new GetCommentRequest.
Parameters
- commentId: string
  
  the comment id.
- Rest ...fields: CommentField[]
  
  the comment fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetCommentRequest
- Defined in main/Client.ts:308

newGetContainerRequest

newGetContainerRequest(containerId: string, ...fields: ContainerField[]): GetContainerRequest
Builds a new GetContainerRequest.

Returns
a new GetCommentRequest.
Parameters
- containerId: string
  
  the container id.
- Rest ...fields: ContainerField[]
  
  the fields to retrieve from the API.
Returns GetContainerRequest
- Defined in main/Client.ts:378

newGetContentPublishingLimitRequest

newGetContentPublishingLimitRequest(...fields: ContentPublishingLimitFields[]): GetContentPublishingLimitRequest
Builds a new GetContentPublishingLimitRequest.

Returns
a new GetContentPublishingLimitRequest.
Parameters
- Rest ...fields: ContentPublishingLimitFields[]
  
  the fields to retrieve.
Returns GetContentPublishingLimitRequest
- Defined in main/Client.ts:524

newGetHashtagIdRequest

newGetHashtagIdRequest(hashtag: string, userId?: string): GetHashtagIdRequest
Builds a new GetHashtagIdRequest.

Returns
a new GetHashtagIdRequest.
Parameters
- hashtag: string
  
  the hashtag.
- userId: string = ...
  
  (optional) the id of the user making the request. If omitted, the page id is used.
Returns GetHashtagIdRequest
- Defined in main/Client.ts:258

newGetHashtagRecentMediaRequest

newGetHashtagRecentMediaRequest(hashtagId: string, userId?: string, ...fields: HashtagMediaField[]): GetHashtagRecentMediaRequest
Builds a new GetHashtagRecentMediaRequest.

Returns
a new GetHashtagRecentMediaRequest.
Parameters
- hashtagId: string
  
  the hashtag id.
- userId: string = ...
  
  (optional) the id of the user making the request. If omitted, the page id is used.
- Rest ...fields: HashtagMediaField[]
  
  the media fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetHashtagRecentMediaRequest
- Defined in main/Client.ts:271

newGetHashtagTopMediaRequest

newGetHashtagTopMediaRequest(hashtagId: string, userId?: string, ...fields: HashtagMediaField[]): GetHashtagTopMediaRequest
Builds a new GetHashtagTopMediaRequest.

Returns
a new GetHashtagTopMediaRequest.
Parameters
- hashtagId: string
  
  the hashtag id.
- userId: string = ...
  
  (optional) the id of the user making the request. If omitted, the page id is used.
- Rest ...fields: HashtagMediaField[]
  
  the media fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetHashtagTopMediaRequest
- Defined in main/Client.ts:290

newGetInstagramAccountInfoRequest

newGetInstagramAccountInfoRequest(): GetInstagramAccountInfoRequest
Builds a new GetInstagramAccountInfoRequest.

Returns
a new GetInstagramAccountInfoRequest.

Returns GetInstagramAccountInfoRequest
- Defined in main/Client.ts:537

newGetMediaChildrenRequest

newGetMediaChildrenRequest(mediaId: string): GetMediaChildrenRequest
Builds a new GetMediaChildrenRequest.

Returns
a new GetMediaChildrenRequest.
Parameters
- mediaId: string
  
  the media object id.
Returns GetMediaChildrenRequest
- Defined in main/Client.ts:193

newGetMediaCommentsRequest

newGetMediaCommentsRequest(mediaId: string, ...fields: CommentField[]): GetMediaCommentsRequest
Builds a new GetMediaCommentsRequest.

Returns
a new GetMediaCommentsRequest.
Parameters
- mediaId: string
  
  the media object id.
- Rest ...fields: CommentField[]
  
  the fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetMediaCommentsRequest
- Defined in main/Client.ts:205

newGetMediaInfoRequest

newGetMediaInfoRequest(mediaId: string, ...fields: MediaField[]): GetMediaInfoRequest
Builds a new GetMediaInfoRequest.

Returns
a new GetMediaInfoRequest.
Parameters
- mediaId: string
  
  the media object id.
- Rest ...fields: MediaField[]
  
  the fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetMediaInfoRequest
- Defined in main/Client.ts:182

newGetPageDayInsightsRequest

newGetPageDayInsightsRequest(...metrics: DayMetric[]): GetPageDayInsightsRequest
Builds a new GetPageDayInsightsRequest.

Returns
a new GetPageDayInsightsRequest.
Parameters
- Rest ...metrics: DayMetric[]
  
  the metrics to retrieve from the API. If no metric is specified, all are retrieved.
Returns GetPageDayInsightsRequest
- Defined in main/Client.ts:144

newGetPageInfoRequest

newGetPageInfoRequest(...fields: PageField[]): GetPageInfoRequest
Builds a new GetPageInfoRequest.

Returns
a new GetPageInfoRequest.
Parameters
- Rest ...fields: PageField[]
  
  the fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetPageInfoRequest
- Defined in main/Client.ts:109

newGetPageLifetimeInsightsRequest

newGetPageLifetimeInsightsRequest(...metrics: LifetimeMetric[]): GetPageLifetimeInsightsRequest
Builds a new GetPageLifetimeInsightsRequest.

Returns
a new GetPageLifetimeInsightsRequest.
Parameters
- Rest ...metrics: LifetimeMetric[]
  
  the metrics to retrieve from the API. If no metric is specified, all are retrieved.
Returns GetPageLifetimeInsightsRequest
- Defined in main/Client.ts:131

newGetPageMediaRequest

newGetPageMediaRequest(...fields: MediaField[]): GetPageMediaRequest
Builds a new GetPageMediaRequest.

Returns
a new GetPageMediaRequest.
Parameters
- Rest ...fields: MediaField[]
  
  the fields to retrieve from the API for each media object. If no field is specified, all are retrieved.
Returns GetPageMediaRequest
- Defined in main/Client.ts:120

newGetPageMonthInsightsRequest

newGetPageMonthInsightsRequest(...metrics: WeekAndMonthMetric[]): GetPageMonthInsightsRequest
Builds a new GetPageMonthInsightsRequest.

Returns
a new GetPageMonthInsightsRequest.
Parameters
- Rest ...metrics: WeekAndMonthMetric[]
  
  the metrics to retrieve from the API. If no metric is specified, all are retrieved.
Returns GetPageMonthInsightsRequest
- Defined in main/Client.ts:168

newGetPageRecentlySearchedHashtagsRequest

newGetPageRecentlySearchedHashtagsRequest(): GetPageRecentlySearchedHashtagsRequest
Builds a new GetPageRecentlySearchedHashtagsRequest.

Returns
a new GetPageRecentlySearchedHashtagsRequest.

Returns GetPageRecentlySearchedHashtagsRequest
- Defined in main/Client.ts:511

newGetPageStoriesRequest

newGetPageStoriesRequest(): GetPageStoriesRequest
Builds a new GetPageStoriesRequest.

Returns
a new GetPageStoriesRequest.

Returns GetPageStoriesRequest
- Defined in main/Client.ts:502

newGetPageWeekInsightsRequest

newGetPageWeekInsightsRequest(...metrics: WeekAndMonthMetric[]): GetPageWeekInsightsRequest
Builds a new GetPageWeekInsightsRequest.

Returns
a new GetPageWeekInsightsRequest.
Parameters
- Rest ...metrics: WeekAndMonthMetric[]
  
  the metrics to retrieve from the API. If no metric is specified, all are retrieved.
Returns GetPageWeekInsightsRequest
- Defined in main/Client.ts:155

newGetRepliesRequest

newGetRepliesRequest(commentId: string, ...fields: CommentField[]): GetRepliesRequest
Builds a new GetRepliesRequest.

Returns
a new GetRepliesRequest.
Parameters
- commentId: string
  
  the comment id.
- Rest ...fields: CommentField[]
  
  the comment fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetRepliesRequest
- Defined in main/Client.ts:343

newGetSimplePostMediaInsightsRequest

newGetSimplePostMediaInsightsRequest(mediaId: string, ...metrics: SimplePostMetric[]): GetSimplePostMediaInsightsRequest
Builds a new GetSimplePostMediaInsightsRequest.

Returns
a new GetSimplePostMediaInsightsRequest.
Parameters
- mediaId: string
  
  the media object id (must be of type 'Photo' or 'Video').
- Rest ...metrics: SimplePostMetric[]
  
  the metrics to retrieve from the API. If no metric is specified, all are retrieved.
Returns GetSimplePostMediaInsightsRequest
- Defined in main/Client.ts:229

newGetStoryMediaInsightsRequest

newGetStoryMediaInsightsRequest(mediaId: string, ...metrics: StoryMetric[]): GetStoryMediaInsightsRequest
Builds a new GetStoryMediaInsightsRequest.

Returns
a new GetStoryMediaInsightsRequest.
Parameters
- mediaId: string
  
  the media object id (must be of type 'Story').
- Rest ...metrics: StoryMetric[]
  
  the metrics to retrieve from the API. If no metric is specified, all are retrieved.
Returns GetStoryMediaInsightsRequest
- Defined in main/Client.ts:246

newGetTagsRequest

newGetTagsRequest(...fields: PublicMediaField[]): GetTagsRequest
Builds a new GetTagsRequest.

Returns
a new GetTagsRequest.
Parameters
- Rest ...fields: PublicMediaField[]
  
  the fields to retrieve from the API for each media object. If no field is specified, all are retrieved.
Returns GetTagsRequest
- Defined in main/Client.ts:366

newPostHideCommentRequest

newPostHideCommentRequest(commentId: string, hide?: boolean): PostHideCommentRequest
Builds a new PostHideCommentRequest.

Returns
a new PostHideCommentRequest.
Parameters
- commentId: string
  
  the comment id.
- hide: boolean = true
  
  whether to hide or show the comment (default: true).
Returns PostHideCommentRequest
- Defined in main/Client.ts:320

newPostMediaCommentRequest

newPostMediaCommentRequest(mediaId: string, text: string): PostMediaCommentRequest
Builds a new PostMediaCommentRequest.

Returns
a new PostMediaCommentRequest.
Parameters
- mediaId: string
  
  the media object id.
- text: string
  
  the text of the comment,
Returns PostMediaCommentRequest
- Defined in main/Client.ts:217

newPostPageCarouselMediaRequest

newPostPageCarouselMediaRequest(children?: string[], caption?: string, locationId?: string): PostPageCarouselMediaRequest
Build a new PostPageCarouselMediaRequest.

Returns
a new PostPageCarouselMediaRequest.
Parameters
- Optional children: string[]
  
  the carousel children.
- Optional caption: string
  
  the caption.
- Optional locationId: string
  
  the location id.
Returns PostPageCarouselMediaRequest
- Defined in main/Client.ts:472

newPostPagePhotoMediaRequest

newPostPagePhotoMediaRequest(imageUrl: string, caption?: string, locationId?: string, userTags?: UserTag[]): PostPagePhotoMediaRequest
Build a new PostPagePhotoMediaRequest.

Returns
a new PostPagePhotoMediaRequest.
Parameters
- imageUrl: string
  
  the image URL.
- Optional caption: string
  
  the caption.
- Optional locationId: string
  
  the location id.
- Optional userTags: UserTag[]
  
  the user_tags.
Returns PostPagePhotoMediaRequest
- Defined in main/Client.ts:392

newPostPageReelMediaRequest

newPostPageReelMediaRequest(videoUrl: string, caption?: string, thumbOffset?: number, shareToFeed?: boolean, locationId?: string): PostPageReelMediaRequest
Build a new PostPageReelMediaRequest.

Returns
a new PostPageReelMediaRequest.
Parameters
- videoUrl: string
  
  the video URL.
- Optional caption: string
  
  the caption.
- Optional thumbOffset: number
  
  the thumbnail offset.
- Optional shareToFeed: boolean
  
  whether the reel should be shared in the feed as well.
- Optional locationId: string
  
  the location id.
Returns PostPageReelMediaRequest
- Defined in main/Client.ts:445

newPostPageVideoMediaRequest

newPostPageVideoMediaRequest(videoUrl: string, caption?: string, thumbOffset?: number, locationId?: string): PostPageVideoMediaRequest
Build a new PostPageVideoMediaRequest.

Returns
a new PostPageVideoMediaRequest.
Parameters
- videoUrl: string
  
  the image URL.
- Optional caption: string
  
  the caption.
- Optional thumbOffset: number
  
  the thumbnail offset time in milliseconds.
- Optional locationId: string
  
  the location id.
Returns PostPageVideoMediaRequest
- Defined in main/Client.ts:418

newPostPublishMediaRequest

newPostPublishMediaRequest(containerId: string): PostPublishMediaRequest
Builds a new PostPublishMediaRequest.

Returns
a new PostPublishMediaRequest.
Parameters
- containerId: string
  
  the container id.
Returns PostPublishMediaRequest
- Defined in main/Client.ts:493

newPostReplyRequest

newPostReplyRequest(commentId: string, text: string): PostReplyRequest
Builds a new PostReplyRequest.

Returns
a new PostReplyRequest.
Parameters
- commentId: string
  
  the comment id.
- text: string
  
  the text of the reply.
Returns PostReplyRequest
- Defined in main/Client.ts:355

Class Client

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

accessToken: string

pageId: string

Optional apiVersion: ApiVersion

Returns Client

Properties

Private Readonly accessToken

Private Optional Readonly apiVersion

Private Readonly pageId

Methods

getAccessToken

Returns

Returns string

getPageId

Returns

Returns string

newDeleteCommentRequest

Returns

Parameters

commentId: string

Returns DeleteCommentRequest

newGetCommentRequest

Returns

Parameters

commentId: string

Rest ...fields: CommentField[]

Returns GetCommentRequest

newGetContainerRequest

Returns

Parameters

containerId: string

Rest ...fields: ContainerField[]

Returns GetContainerRequest

newGetContentPublishingLimitRequest

Returns

Parameters

Rest ...fields: ContentPublishingLimitFields[]

Returns GetContentPublishingLimitRequest

newGetHashtagIdRequest

Returns

Parameters

hashtag: string

userId: string = ...

Returns GetHashtagIdRequest

newGetHashtagRecentMediaRequest

Returns

Parameters

hashtagId: string

userId: string = ...

Rest ...fields: HashtagMediaField[]

Returns GetHashtagRecentMediaRequest

newGetHashtagTopMediaRequest

Returns

Parameters

hashtagId: string

userId: string = ...

Rest ...fields: HashtagMediaField[]

Returns GetHashtagTopMediaRequest

newGetInstagramAccountInfoRequest

Returns

Returns GetInstagramAccountInfoRequest

newGetMediaChildrenRequest

Returns

Parameters

mediaId: string

Returns GetMediaChildrenRequest

newGetMediaCommentsRequest

Returns

Parameters

mediaId: string

`Optional` apiVersion: ApiVersion

`Private` `Readonly` accessToken

`Private` `Optional` `Readonly` apiVersion

`Private` `Readonly` pageId

`Rest` ...fields: CommentField[]

`Rest` ...fields: ContainerField[]

`Rest` ...fields: ContentPublishingLimitFields[]

`Rest` ...fields: HashtagMediaField[]

`Rest` ...fields: HashtagMediaField[]

`Rest` ...fields: CommentField[]

`Rest` ...fields: MediaField[]

`Rest` ...metrics: DayMetric[]

`Rest` ...fields: PageField[]

`Rest` ...metrics: LifetimeMetric[]

`Rest` ...fields: MediaField[]

`Rest` ...metrics: WeekAndMonthMetric[]

`Rest` ...metrics: WeekAndMonthMetric[]

`Rest` ...fields: CommentField[]

`Rest` ...metrics: SimplePostMetric[]

`Rest` ...metrics: StoryMetric[]

`Rest` ...fields: PublicMediaField[]