igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface FeedTimelinePostItemActions

    The actions of FeedTimelinePostItem: the methods you call on an item of the list.

    interface FeedTimelinePostItemActions {
        like: (
            ...args: [],
        ) => Effect<
            | {
                data: {
                    xig_media_like: {
                        media: {
                            __typename?: string;
                            has_liked: boolean;
                            id: string;
                            strong_id__?: string;
                        };
                    };
                };
            } & { raw: ActionRaw }
            | MediaLikeRestResponse & { raw: ActionRaw },

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | SchemaError
                | GraphqlRootFieldMissingError
                | ScreenEnterConcurrentError,
            never,
        >;
        likeCarouselChild: (
            ...args: [],
        ) => Effect<
            | {
                data: {
                    xig_media_like: {
                        media: {
                            __typename?: string;
                            has_liked: boolean;
                            id: string;
                            strong_id__?: string;
                        };
                    };
                };
            } & { raw: ActionRaw }
            | MediaLikeRestResponse & { raw: ActionRaw },

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | SchemaError
                | GraphqlRootFieldMissingError
                | ScreenEnterConcurrentError
                | CarouselSlideNotFoundError
                | CarouselSlidesNotLoadedError,
            never,
        >;
        open: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "PostOpenedFromLink",
                "screen",
                {
                    carousel?: {
                        children: readonly string[];
                        size?: number;
                        slide?: number;
                    };
                    mediaId: string;
                    trackingToken: string;
                },
                PostOpenedFromLinkActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                "mediaId",
                AndroidScreens,
            >,

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
        share: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "DirectShareSheet",
                "screen",
                {
                    share: | {
                        carousel_share_child_media_id?: string;
                        inventory_source?: string;
                        kind: "post";
                        media_id: string;
                        media_type: number;
                        ranking_info_token?: string;
                        send_attribution: "feed_timeline";
                    }
                    | {
                        carousel_share_child_media_id?: string;
                        kind: "carousel";
                        media_id: string;
                        media_type: number;
                        send_attribution: "feed_contextual_profile";
                    }
                    | { kind: "reel"; media_id: string }
                    | { kind: "profile"; send_attribution: "profile"; user_id: string };
                    threads: readonly {
                        is_group: boolean;
                        muted?: boolean;
                        preview: readonly {
                            client_context?: string;
                            command_count?: number;
                            edit_count?: number;
                            item_id: string;
                            item_type: string;
                            media?:
                                | {
                                    height: number;
                                    media_type: 1;
                                    pk: string;
                                    url: string;
                                    width: number;
                                }
                                | {
                                    height: number;
                                    media_type: 2;
                                    pk: string;
                                    url: string;
                                    width: number;
                                }
                                | { media_type: 8; pk: string; slides: readonly (...)[] };
                            message_ephemeral_lifetime_ms?: string;
                            text?: string;
                            timestamp: string;
                            user_id: string;
                        }[];
                        thread_id: string;
                        thread_title: string;
                        thread_v2_id?: string;
                        users: readonly {
                            fbid_v2?: string;
                            full_name: string;
                            pk: string;
                            username: string;
                        }[];
                    }[];
                },
                DirectShareSheetActions,
                DirectShareSheetItems,
                ScreenHandle,
                "required",
                true,
                never,
                unknown,
            >,
            ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
            never,
        >;
        swipeToSlide: <Self extends ScreenHandle>(
            this: Self,
            ...args: [index: number],
        ) => Effect<
            Self,
            ScreenDataActionFailure<
                CarouselSlideNotFoundError
                | CarouselSlidesNotLoadedError,
            >,
            never,
        >;
        unlikeCarouselChild: (
            ...args: [],
        ) => Effect<
            ActionValue<string>,

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | ScreenEnterConcurrentError
                | CarouselSlideNotFoundError
                | CarouselSlidesNotLoadedError,
            never,
        >;
    }
    Index

    Properties

    like likeCarouselChild open share swipeToSlide unlikeCarouselChild

    Properties

    like: (
        ...args: [],
    ) => Effect<
        | {
            data: {
                xig_media_like: {
                    media: {
                        __typename?: string;
                        has_liked: boolean;
                        id: string;
                        strong_id__?: string;
                    };
                };
            };
        } & { raw: ActionRaw }
        | MediaLikeRestResponse & { raw: ActionRaw },

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | SchemaError
            | GraphqlRootFieldMissingError
            | ScreenEnterConcurrentError,
        never,
    >

    Taps the heart on the post. Answers the like's result.

    likeCarouselChild: (
        ...args: [],
    ) => Effect<
        | {
            data: {
                xig_media_like: {
                    media: {
                        __typename?: string;
                        has_liked: boolean;
                        id: string;
                        strong_id__?: string;
                    };
                };
            };
        } & { raw: ActionRaw }
        | MediaLikeRestResponse & { raw: ActionRaw },

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | SchemaError
            | GraphqlRootFieldMissingError
            | ScreenEnterConcurrentError
            | CarouselSlideNotFoundError
            | CarouselSlidesNotLoadedError,
        never,
    >

    Likes the slide in front of the post's carousel (the one swiped to, the first when you never swiped). A post that is no carousel fails with CarouselSlideNotFoundError.

    open: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "PostOpenedFromLink",
            "screen",
            {
                carousel?: {
                    children: readonly string[];
                    size?: number;
                    slide?: number;
                };
                mediaId: string;
                trackingToken: string;
            },
            PostOpenedFromLinkActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            "mediaId",
            AndroidScreens,
        >,

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps the post and opens it. Answers the post screen's handle.

    share: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "DirectShareSheet",
            "screen",
            {
                share: | {
                    carousel_share_child_media_id?: string;
                    inventory_source?: string;
                    kind: "post";
                    media_id: string;
                    media_type: number;
                    ranking_info_token?: string;
                    send_attribution: "feed_timeline";
                }
                | {
                    carousel_share_child_media_id?: string;
                    kind: "carousel";
                    media_id: string;
                    media_type: number;
                    send_attribution: "feed_contextual_profile";
                }
                | { kind: "reel"; media_id: string }
                | { kind: "profile"; send_attribution: "profile"; user_id: string };
                threads: readonly {
                    is_group: boolean;
                    muted?: boolean;
                    preview: readonly {
                        client_context?: string;
                        command_count?: number;
                        edit_count?: number;
                        item_id: string;
                        item_type: string;
                        media?:
                            | {
                                height: number;
                                media_type: 1;
                                pk: string;
                                url: string;
                                width: number;
                            }
                            | {
                                height: number;
                                media_type: 2;
                                pk: string;
                                url: string;
                                width: number;
                            }
                            | { media_type: 8; pk: string; slides: readonly (...)[] };
                        message_ephemeral_lifetime_ms?: string;
                        text?: string;
                        timestamp: string;
                        user_id: string;
                    }[];
                    thread_id: string;
                    thread_title: string;
                    thread_v2_id?: string;
                    users: readonly {
                        fbid_v2?: string;
                        full_name: string;
                        pk: string;
                        username: string;
                    }[];
                }[];
            },
            DirectShareSheetActions,
            DirectShareSheetItems,
            ScreenHandle,
            "required",
            true,
            never,
            unknown,
        >,
        ScreenEnterConcurrentError
        | ScreenDataError
        | ScreenEdgeInputError,
        never,
    >

    Taps the paper plane in the post's actions row and opens the Direct share sheet on this post. Nothing is sent until you pick a conversation in the sheet. Answers the sheet's handle.

    swipeToSlide: <Self extends ScreenHandle>(
        this: Self,
        ...args: [index: number],
    ) => Effect<
        Self,
        ScreenDataActionFailure<
            CarouselSlideNotFoundError
            | CarouselSlidesNotLoadedError,
        >,
        never,
    >

    Swipes the post's carousel to slide index (zero-based). Nothing is sent. Answers the post shown again with that slide in front; continue from it. A post that is no carousel, or holds no such slide, fails with CarouselSlideNotFoundError.

    unlikeCarouselChild: (
        ...args: [],
    ) => Effect<
        ActionValue<string>,

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | ScreenEnterConcurrentError
            | CarouselSlideNotFoundError
            | CarouselSlidesNotLoadedError,
        never,
    >

    Takes back the like of the slide in front of the post's carousel.

    Settings

    Member Visibility

    On This Page

    Properties