Skip to content

Latest commit

 

History

History
790 lines (451 loc) · 19.6 KB

FeedFactory.md

File metadata and controls

790 lines (451 loc) · 19.6 KB

instagram-private-api / index / FeedFactory

Class: FeedFactory

index.FeedFactory

Table of contents

Constructors

Methods

Constructors

constructor

new FeedFactory(client)

Parameters

Name Type
client IgApiClient

Defined in

src/core/feed.factory.ts:54

Methods

accountFollowers

accountFollowers(options?): AccountFollowersFeed

Parameters

Name Type
options? string | number | Partial<Pick<AccountFollowersFeed, "searchSurface" | "order" | "query" | "enableGroups" | "id">>

Returns

AccountFollowersFeed

Defined in

src/core/feed.factory.ts:56


accountFollowing

accountFollowing(options?): AccountFollowingFeed

Parameters

Name Type
options? string | number | Partial<Pick<AccountFollowingFeed, "searchSurface" | "order" | "query" | "enableGroups" | "id" | "includesHashtags">>

Returns

AccountFollowingFeed

Defined in

src/core/feed.factory.ts:68


bestFriendships

bestFriendships(): BestiesFeed

Returns

BestiesFeed

Defined in

src/core/feed.factory.ts:94


blockedUsers

blockedUsers(): BlockedUsersFeed

Returns

BlockedUsersFeed

Defined in

src/core/feed.factory.ts:98


directInbox

directInbox(): DirectInboxFeed

Returns

DirectInboxFeed

Defined in

src/core/feed.factory.ts:102


directPending

directPending(): DirectPendingInboxFeed

Returns

DirectPendingInboxFeed

Defined in

src/core/feed.factory.ts:106


directThread

directThread(options, seqId?): DirectThreadFeed

Parameters

Name Type
options Pick<DirectInboxFeedResponseThreadsItem, "thread_id" | "oldest_cursor">
seqId? number

Returns

DirectThreadFeed

Defined in

src/core/feed.factory.ts:110


discover

discover(): DiscoverFeed

Returns

DiscoverFeed

Defined in

src/core/feed.factory.ts:86


igtvBrowse

igtvBrowse(isPrefetch?): IgtvBrowseFeed

Parameters

Name Type
isPrefetch? boolean

Returns

IgtvBrowseFeed

Defined in

src/core/feed.factory.ts:234


igtvChaining

igtvChaining(id): IgtvChannelFeed

Returns the suggested videos after the current (id) one

Parameters

Name Type Description
id string | number pk of the video

Returns

IgtvChannelFeed

Defined in

src/core/feed.factory.ts:314


igtvChannel

igtvChannel(id): IgtvChannelFeed

Parameters

Name Type
id string | number

Returns

IgtvChannelFeed

Defined in

src/core/feed.factory.ts:301


liked

liked(): LikedFeed

Returns

LikedFeed

Defined in

src/core/feed.factory.ts:318


listReelMediaViewers

listReelMediaViewers(mediaId): ListReelMediaViewerFeed

Parameters

Name Type
mediaId string

Returns

ListReelMediaViewerFeed

Defined in

src/core/feed.factory.ts:222


location

location(id, tab?): LocationFeed

Parameters

Name Type Default value
id string | number undefined
tab "recent" | "ranked" 'ranked'

Returns

LocationFeed

Defined in

src/core/feed.factory.ts:140


mediaComments

mediaComments(id): MediaCommentsFeed

Parameters

Name Type
id string

Returns

MediaCommentsFeed

Defined in

src/core/feed.factory.ts:147


mediaInlineChildComments

mediaInlineChildComments(mediaId, commentId, minId?): MediaInlineChildCommentsFeed

Parameters

Name Type
mediaId string
commentId string
minId? string

Returns

MediaInlineChildCommentsFeed

Defined in

src/core/feed.factory.ts:226


musicGenre

musicGenre(id, product?): MusicGenreFeed

Parameters

Name Type Default value
id string | number undefined
product string 'story_camera_music_overlay_post_capture'

Returns

MusicGenreFeed

Defined in

src/core/feed.factory.ts:186


musicMood

musicMood(id, product?): MusicMoodFeed

Parameters

Name Type Default value
id string | number undefined
product string 'story_camera_music_overlay_post_capture'

Returns

MusicMoodFeed

Defined in

src/core/feed.factory.ts:196


musicSearch

musicSearch(query, product?): MusicSearchFeed

Parameters

Name Type Default value
query string undefined
product string 'story_camera_music_overlay_post_capture'

Returns

MusicSearchFeed

Defined in

src/core/feed.factory.ts:177


musicTrending

musicTrending(product?): MusicTrendingFeed

Parameters

Name Type Default value
product string 'story_camera_music_overlay_post_capture'

Returns

MusicTrendingFeed

Defined in

src/core/feed.factory.ts:173


news

news(): NewsFeed

Returns

NewsFeed

Defined in

src/core/feed.factory.ts:82


pendingFriendships

pendingFriendships(): PendingFriendshipsFeed

Returns

PendingFriendshipsFeed

Defined in

src/core/feed.factory.ts:90


postsInsightsFeed

postsInsightsFeed(options): PostsInsightsFeed

Parameters

Name Type
options PostsInsightsFeedOptions

Returns

PostsInsightsFeed

Defined in

src/core/feed.factory.ts:210


reelsMedia

reelsMedia(options): ReelsMediaFeed

Parameters

Name Type
options Object
options.source? string
options.userIds (string | number)[]

Returns

ReelsMediaFeed

Defined in

src/core/feed.factory.ts:153


reelsTray

reelsTray(reason?): ReelsTrayFeed

Parameters

Name Type Default value
reason "pull_to_refresh" | "cold_start" 'cold_start'

Returns

ReelsTrayFeed

Defined in

src/core/feed.factory.ts:161


saved

saved(): SavedFeed

Returns

SavedFeed

Defined in

src/core/feed.factory.ts:218


storiesInsights

storiesInsights(timeframe): StoriesInsightsFeed

Parameters

Name Type
timeframe "ONE_DAY" | "ONE_WEEK" | "TWO_WEEKS"

Returns

StoriesInsightsFeed

Defined in

src/core/feed.factory.ts:214


storyPollVoters

storyPollVoters(mediaId, stickerId): MediaStickerResponsesFeed<StoryPollVotersFeedResponseRootObject, StoryPollVotersFeedResponseVotersItem>

Parameters

Name Type
mediaId string
stickerId string | number

Returns

MediaStickerResponsesFeed<StoryPollVotersFeedResponseRootObject, StoryPollVotersFeedResponseVotersItem>

Defined in

src/core/feed.factory.ts:256


storyQuestionResponses

storyQuestionResponses(mediaId, stickerId): MediaStickerResponsesFeed<StoryQuestionResponsesFeedResponseRootObject, StoryQuestionResponsesFeedResponseRespondersItem>

Parameters

Name Type
mediaId string
stickerId string | number

Returns

MediaStickerResponsesFeed<StoryQuestionResponsesFeedResponseRootObject, StoryQuestionResponsesFeedResponseRespondersItem>

Defined in

src/core/feed.factory.ts:240


storyQuizParticipants

storyQuizParticipants(mediaId, stickerId): MediaStickerResponsesFeed<StoryQuizParticipantsFeedResponseRootObject, StoryQuizParticipantsFeedResponseParticipantsItem>

Parameters

Name Type
mediaId string
stickerId string | number

Returns

MediaStickerResponsesFeed<StoryQuizParticipantsFeedResponseRootObject, StoryQuizParticipantsFeedResponseParticipantsItem>

Defined in

src/core/feed.factory.ts:269


storySliderVoters

storySliderVoters(mediaId, stickerId): MediaStickerResponsesFeed<StorySliderVotersFeedResponseResponseRootObject, StorySliderVotersFeedResponseResponseVotersItem>

Parameters

Name Type
mediaId string
stickerId string | number

Returns

MediaStickerResponsesFeed<StorySliderVotersFeedResponseResponseRootObject, StorySliderVotersFeedResponseResponseVotersItem>

Defined in

src/core/feed.factory.ts:285


tag

tag(tag): TagFeed

Parameters

Name Type
tag string

Returns

TagFeed

Defined in

src/core/feed.factory.ts:127


tags

tags(tag, tab?): TagsFeed

Parameters

Name Type Default value
tag string undefined
tab "top" | "recent" | "places" 'top'

Returns

TagsFeed

Defined in

src/core/feed.factory.ts:133


timeline

timeline(reason?): TimelineFeed

Parameters

Name Type
reason? TimelineFeedReason

Returns

TimelineFeed

Defined in

src/core/feed.factory.ts:165


topicalExplore

topicalExplore(options?): TopicalExploreFeed

Parameters

Name Type
options Partial<Pick<TopicalExploreFeed, "sessionId" | "clusterId" | "lat" | "lng" | "module">>

Returns

TopicalExploreFeed

Defined in

src/core/feed.factory.ts:322


user

user(id): UserFeed

Parameters

Name Type
id string | number

Returns

UserFeed

Defined in

src/core/feed.factory.ts:121


userStory

userStory(userId): UserStoryFeed

Parameters

Name Type
userId string | number

Returns

UserStoryFeed

Defined in

src/core/feed.factory.ts:157


usertags

usertags(id): UsertagsFeed

Parameters

Name Type
id string | number

Returns

UsertagsFeed

Defined in

src/core/feed.factory.ts:206