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

    Interface PostingStoryPhotoEditorActions

    The actions of PostingStoryPhotoEditorScreen: the methods you call on its handle while the screen is open.

    interface PostingStoryPhotoEditorActions {
        openShareSheet: (
            ...args: [options: PostingStoryShareOptions],
        ) => Effect<
            AssembledHandle<
                "PostingStoryShareSheet",
                "screen",
                { sharedAt: number },
                PostingStoryShareSheetActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,
            ScreenEnterConcurrentError | ScreenDataError | ScreenEdgeInputError,
            never,
        >;
        openStickerTray: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "PostingStoryStickerTray",
                "screen",
                {},
                PostingStoryStickerTrayActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,

                | IgCheckpointError
                | IgAccountSuspendedError
                | IgAccountDisabledError
                | IgLoginRequiredError
                | IgUserLoggedOutError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
        shareToYourStory: <Self extends ScreenHandle>(
            this: Self,
            ...args: [options: { caption?: string }],
        ) => Effect<
            { code?: string; mediaId: string; raw: ActionRaw },

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | PostingPhotoEncodeError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | PostingMediaNotInProcessError
                | PostingStoryNotPublishedError,
            never,
        >;
    }
    Index

    Properties

    openShareSheet: (
        ...args: [options: PostingStoryShareOptions],
    ) => Effect<
        AssembledHandle<
            "PostingStoryShareSheet",
            "screen",
            { sharedAt: number },
            PostingStoryShareSheetActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,
        ScreenEnterConcurrentError | ScreenDataError | ScreenEdgeInputError,
        never,
    >

    Taps the next arrow and opens the share sheet with the caption typed in the editor (options). Answers its handle.

    openStickerTray: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "PostingStoryStickerTray",
            "screen",
            {},
            PostingStoryStickerTrayActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | IgCheckpointError
            | IgAccountSuspendedError
            | IgAccountDisabledError
            | IgLoginRequiredError
            | IgUserLoggedOutError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps the sticker button and opens the sticker tray. Answers its handle.

    shareToYourStory: <Self extends ScreenHandle>(
        this: Self,
        ...args: [options: { caption?: string }],
    ) => Effect<
        { code?: string; mediaId: string; raw: ActionRaw },

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | PostingPhotoEncodeError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | PostingMediaNotInProcessError
            | PostingStoryNotPublishedError,
        never,
    >

    Taps Your story: shares the photo at once. The caption is checked, the photo is uploaded, the creation screens close and the story is configured; the action waits until the server has made it. Answers the story the server created.