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

    Variable opensConst

    opens: {
        <
            const Id extends
                | "LoginHomepage"
                | "LoginTwoFactorEntrypoint"
                | "LoginTwoFactorMethodPicker"
                | "LoginTwoFactorEnterTotpCode"
                | "AccountRecoverySearch"
                | "AccountRecoveryAuthenticationConfirmation"
                | "AccountRecoveryEmailCode"
                | "RegistrationPhoneNumber"
                | "RegistrationConfirmationCode"
                | "RegistrationPassword"
                | "RegistrationBirthday"
                | "RegistrationName"
                | "RegistrationUsername"
                | "RegistrationTermsOfService"
                | "AccountRecoverySuccessLocationPermission"
                | "FeedTimeline"
                | "PostOpenedFromLink"
                | "ReelsViewer"
                | "MediaComments"
                | "RepostNoteEditor"
                | "Explore"
                | "SearchInput"
                | "SearchResultsTopTab"
                | "SearchResultsAccountsTab"
                | "UserProfile"
                | "MyProfile"
                | "EditProfile"
                | "EditProfileBio"
                | "EditProfileUsername"
                | "EditProfileLinks"
                | "EditProfileAddLink"
                | "ProfilePostsFeed"
                | "FeedTimelineFollowing"
                | "UserProfileReelsTab"
                | "DirectInbox"
                | "DirectRecipientPicker"
                | "DirectThread"
                | "DirectCustomizeChat"
                | "DirectThreadThemePicker"
                | "DirectThreadDetails"
                | "DirectThreadSharedMedia"
                | "DirectThreadNicknameChange"
                | "DirectGroupNameAndPhotoEditor"
                | "PostingGalleryPicker"
                | "PostingPostEdit"
                | "PostingNewPost"
                | "PostingCamera"
                | "PostingCameraGallery"
                | "PostingReelEditor"
                | "PostingNewReel"
                | "PostingStoryPhotoEditor"
                | "PostingStoryVideoEditor"
                | "PostingStoryStickerTray"
                | "PostingStoryMusicStickerEditor"
                | "PostingStoryShareSheet"
                | "PostingStoryAlsoShareTo"
                | "PostingMusicBrowser"
                | "PostingMusicSearchResults"
                | "PostingReelMusicEditor"
                | "ChallengeSelectVerifyMethod"
                | "ChallengeVerifyCode"
                | "ChallengeSubmitPhone"
                | "ChallengeSetNewPassword"
                | "ChallengeAddBirthday"
                | "ChallengeLoginReview"
                | "ChallengeAccountTemporarilyLocked"
                | "ChallengeEscalationInformation"
                | "ChallengeReviewContactPointChange"
                | "ChallengeScrapingWarning"
                | "ChallengeWebRecaptcha"
                | "ChallengeWebSetNewPassword"
                | "ChallengeTextCaptcha"
                | "ChallengeRecaptcha"
                | "ChallengeSetContactPoint"
                | "ChallengeContactPointCode"
                | "ChallengeAuthenticityWizard"
                | "ChallengeAwaitingReview"
                | "ChallengeThanksForProvidingInfo"
                | "ChallengeAccountSuspended",
            State,
            Step extends ScreenEdgeStep<unknown>,
        >(
            id: Id,
            step: (state: State) => Step,
        ): (
            self: ScreenHandle,
            state: State,
        ) => ScreenEdgeBound<
            ScreenEdgeShape<AndroidScreens[Id], [], Step["source"], AndroidScreens>,
            ScreenEdgeCall<
                AndroidScreens[Id],
                [],
                Step["input"],
                AndroidScreens,
                Step["source"],
            >,
        >;
        <
            const Id extends
                | "LoginHomepage"
                | "LoginTwoFactorEntrypoint"
                | "LoginTwoFactorMethodPicker"
                | "LoginTwoFactorEnterTotpCode"
                | "AccountRecoverySearch"
                | "AccountRecoveryAuthenticationConfirmation"
                | "AccountRecoveryEmailCode"
                | "RegistrationPhoneNumber"
                | "RegistrationConfirmationCode"
                | "RegistrationPassword"
                | "RegistrationBirthday"
                | "RegistrationName"
                | "RegistrationUsername"
                | "RegistrationTermsOfService"
                | "AccountRecoverySuccessLocationPermission"
                | "FeedTimeline"
                | "PostOpenedFromLink"
                | "ReelsViewer"
                | "MediaComments"
                | "RepostNoteEditor"
                | "Explore"
                | "SearchInput"
                | "SearchResultsTopTab"
                | "SearchResultsAccountsTab"
                | "UserProfile"
                | "MyProfile"
                | "EditProfile"
                | "EditProfileBio"
                | "EditProfileUsername"
                | "EditProfileLinks"
                | "EditProfileAddLink"
                | "ProfilePostsFeed"
                | "FeedTimelineFollowing"
                | "UserProfileReelsTab"
                | "DirectInbox"
                | "DirectRecipientPicker"
                | "DirectThread"
                | "DirectCustomizeChat"
                | "DirectThreadThemePicker"
                | "DirectThreadDetails"
                | "DirectThreadSharedMedia"
                | "DirectThreadNicknameChange"
                | "DirectGroupNameAndPhotoEditor"
                | "PostingGalleryPicker"
                | "PostingPostEdit"
                | "PostingNewPost"
                | "PostingCamera"
                | "PostingCameraGallery"
                | "PostingReelEditor"
                | "PostingNewReel"
                | "PostingStoryPhotoEditor"
                | "PostingStoryVideoEditor"
                | "PostingStoryStickerTray"
                | "PostingStoryMusicStickerEditor"
                | "PostingStoryShareSheet"
                | "PostingStoryAlsoShareTo"
                | "PostingMusicBrowser"
                | "PostingMusicSearchResults"
                | "PostingReelMusicEditor"
                | "ChallengeSelectVerifyMethod"
                | "ChallengeVerifyCode"
                | "ChallengeSubmitPhone"
                | "ChallengeSetNewPassword"
                | "ChallengeAddBirthday"
                | "ChallengeLoginReview"
                | "ChallengeAccountTemporarilyLocked"
                | "ChallengeEscalationInformation"
                | "ChallengeReviewContactPointChange"
                | "ChallengeScrapingWarning"
                | "ChallengeWebRecaptcha"
                | "ChallengeWebSetNewPassword"
                | "ChallengeTextCaptcha"
                | "ChallengeRecaptcha"
                | "ChallengeSetContactPoint"
                | "ChallengeContactPointCode"
                | "ChallengeAuthenticityWizard"
                | "ChallengeAwaitingReview"
                | "ChallengeThanksForProvidingInfo"
                | "ChallengeAccountSuspended",
            State,
            Args extends readonly unknown[],
            Step extends ScreenEdgeStep<unknown>,
        >(
            id: Id,
            step: (state: State, ...args: NoInfer) => Step,
            args: ScreenCodec<Args>,
        ): (
            self: ScreenHandle,
            state: State,
        ) => ScreenEdgeBound<
            ScreenEdgeShape<
                AndroidScreens[Id],
                Args,
                Step["source"],
                AndroidScreens,
            >,
            ScreenEdgeCall<
                AndroidScreens[Id],
                Args,
                Step["input"],
                AndroidScreens,
                Step["source"],
            >,
        >;
    } = androidScreenEdges.opens

    The transitions of the platform's screens, typed by AndroidScreens.

    Type Declaration

      • <
            const Id extends
                | "LoginHomepage"
                | "LoginTwoFactorEntrypoint"
                | "LoginTwoFactorMethodPicker"
                | "LoginTwoFactorEnterTotpCode"
                | "AccountRecoverySearch"
                | "AccountRecoveryAuthenticationConfirmation"
                | "AccountRecoveryEmailCode"
                | "RegistrationPhoneNumber"
                | "RegistrationConfirmationCode"
                | "RegistrationPassword"
                | "RegistrationBirthday"
                | "RegistrationName"
                | "RegistrationUsername"
                | "RegistrationTermsOfService"
                | "AccountRecoverySuccessLocationPermission"
                | "FeedTimeline"
                | "PostOpenedFromLink"
                | "ReelsViewer"
                | "MediaComments"
                | "RepostNoteEditor"
                | "Explore"
                | "SearchInput"
                | "SearchResultsTopTab"
                | "SearchResultsAccountsTab"
                | "UserProfile"
                | "MyProfile"
                | "EditProfile"
                | "EditProfileBio"
                | "EditProfileUsername"
                | "EditProfileLinks"
                | "EditProfileAddLink"
                | "ProfilePostsFeed"
                | "FeedTimelineFollowing"
                | "UserProfileReelsTab"
                | "DirectInbox"
                | "DirectRecipientPicker"
                | "DirectThread"
                | "DirectCustomizeChat"
                | "DirectThreadThemePicker"
                | "DirectThreadDetails"
                | "DirectThreadSharedMedia"
                | "DirectThreadNicknameChange"
                | "DirectGroupNameAndPhotoEditor"
                | "PostingGalleryPicker"
                | "PostingPostEdit"
                | "PostingNewPost"
                | "PostingCamera"
                | "PostingCameraGallery"
                | "PostingReelEditor"
                | "PostingNewReel"
                | "PostingStoryPhotoEditor"
                | "PostingStoryVideoEditor"
                | "PostingStoryStickerTray"
                | "PostingStoryMusicStickerEditor"
                | "PostingStoryShareSheet"
                | "PostingStoryAlsoShareTo"
                | "PostingMusicBrowser"
                | "PostingMusicSearchResults"
                | "PostingReelMusicEditor"
                | "ChallengeSelectVerifyMethod"
                | "ChallengeVerifyCode"
                | "ChallengeSubmitPhone"
                | "ChallengeSetNewPassword"
                | "ChallengeAddBirthday"
                | "ChallengeLoginReview"
                | "ChallengeAccountTemporarilyLocked"
                | "ChallengeEscalationInformation"
                | "ChallengeReviewContactPointChange"
                | "ChallengeScrapingWarning"
                | "ChallengeWebRecaptcha"
                | "ChallengeWebSetNewPassword"
                | "ChallengeTextCaptcha"
                | "ChallengeRecaptcha"
                | "ChallengeSetContactPoint"
                | "ChallengeContactPointCode"
                | "ChallengeAuthenticityWizard"
                | "ChallengeAwaitingReview"
                | "ChallengeThanksForProvidingInfo"
                | "ChallengeAccountSuspended",
            State,
            Step extends ScreenEdgeStep<unknown>,
        >(
            id: Id,
            step: (state: State) => Step,
        ): (
            self: ScreenHandle,
            state: State,
        ) => ScreenEdgeBound<
            ScreenEdgeShape<AndroidScreens[Id], [], Step["source"], AndroidScreens>,
            ScreenEdgeCall<
                AndroidScreens[Id],
                [],
                Step["input"],
                AndroidScreens,
                Step["source"],
            >,
        >
      • A transition into the screen id: calling it runs the target's enter and returns the target's handle, whose origin is the handle the edge was taken from (none for a tab). step maps the screen's state (and the caller's arguments) to the edge's source, ordinal skip and the target's input. An edge that takes arguments declares their schema (a tuple) third, so a trail can store them.

        The edge is taken only while its screen is on top (an item's: while its host is), else it dies with ScreenNotOnTopError (a defect); an input the target's schema refuses is ScreenEdgeInputError.

        The target's handle is typed by the registry, not by the handle the edge is taken from: its origin is what can open the target (ScreenOpenersOf, ScreenItemOpenersOf), so an action that takes its own screen's edge (handleAction) uses this same declaration.

        Type Parameters

        • const Id extends
              | "LoginHomepage"
              | "LoginTwoFactorEntrypoint"
              | "LoginTwoFactorMethodPicker"
              | "LoginTwoFactorEnterTotpCode"
              | "AccountRecoverySearch"
              | "AccountRecoveryAuthenticationConfirmation"
              | "AccountRecoveryEmailCode"
              | "RegistrationPhoneNumber"
              | "RegistrationConfirmationCode"
              | "RegistrationPassword"
              | "RegistrationBirthday"
              | "RegistrationName"
              | "RegistrationUsername"
              | "RegistrationTermsOfService"
              | "AccountRecoverySuccessLocationPermission"
              | "FeedTimeline"
              | "PostOpenedFromLink"
              | "ReelsViewer"
              | "MediaComments"
              | "RepostNoteEditor"
              | "Explore"
              | "SearchInput"
              | "SearchResultsTopTab"
              | "SearchResultsAccountsTab"
              | "UserProfile"
              | "MyProfile"
              | "EditProfile"
              | "EditProfileBio"
              | "EditProfileUsername"
              | "EditProfileLinks"
              | "EditProfileAddLink"
              | "ProfilePostsFeed"
              | "FeedTimelineFollowing"
              | "UserProfileReelsTab"
              | "DirectInbox"
              | "DirectRecipientPicker"
              | "DirectThread"
              | "DirectCustomizeChat"
              | "DirectThreadThemePicker"
              | "DirectThreadDetails"
              | "DirectThreadSharedMedia"
              | "DirectThreadNicknameChange"
              | "DirectGroupNameAndPhotoEditor"
              | "PostingGalleryPicker"
              | "PostingPostEdit"
              | "PostingNewPost"
              | "PostingCamera"
              | "PostingCameraGallery"
              | "PostingReelEditor"
              | "PostingNewReel"
              | "PostingStoryPhotoEditor"
              | "PostingStoryVideoEditor"
              | "PostingStoryStickerTray"
              | "PostingStoryMusicStickerEditor"
              | "PostingStoryShareSheet"
              | "PostingStoryAlsoShareTo"
              | "PostingMusicBrowser"
              | "PostingMusicSearchResults"
              | "PostingReelMusicEditor"
              | "ChallengeSelectVerifyMethod"
              | "ChallengeVerifyCode"
              | "ChallengeSubmitPhone"
              | "ChallengeSetNewPassword"
              | "ChallengeAddBirthday"
              | "ChallengeLoginReview"
              | "ChallengeAccountTemporarilyLocked"
              | "ChallengeEscalationInformation"
              | "ChallengeReviewContactPointChange"
              | "ChallengeScrapingWarning"
              | "ChallengeWebRecaptcha"
              | "ChallengeWebSetNewPassword"
              | "ChallengeTextCaptcha"
              | "ChallengeRecaptcha"
              | "ChallengeSetContactPoint"
              | "ChallengeContactPointCode"
              | "ChallengeAuthenticityWizard"
              | "ChallengeAwaitingReview"
              | "ChallengeThanksForProvidingInfo"
              | "ChallengeAccountSuspended"
        • State
        • Step extends ScreenEdgeStep<unknown>

        Parameters

        Returns (
            self: ScreenHandle,
            state: State,
        ) => ScreenEdgeBound<
            ScreenEdgeShape<AndroidScreens[Id], [], Step["source"], AndroidScreens>,
            ScreenEdgeCall<
                AndroidScreens[Id],
                [],
                Step["input"],
                AndroidScreens,
                Step["source"],
            >,
        >

      • <
            const Id extends
                | "LoginHomepage"
                | "LoginTwoFactorEntrypoint"
                | "LoginTwoFactorMethodPicker"
                | "LoginTwoFactorEnterTotpCode"
                | "AccountRecoverySearch"
                | "AccountRecoveryAuthenticationConfirmation"
                | "AccountRecoveryEmailCode"
                | "RegistrationPhoneNumber"
                | "RegistrationConfirmationCode"
                | "RegistrationPassword"
                | "RegistrationBirthday"
                | "RegistrationName"
                | "RegistrationUsername"
                | "RegistrationTermsOfService"
                | "AccountRecoverySuccessLocationPermission"
                | "FeedTimeline"
                | "PostOpenedFromLink"
                | "ReelsViewer"
                | "MediaComments"
                | "RepostNoteEditor"
                | "Explore"
                | "SearchInput"
                | "SearchResultsTopTab"
                | "SearchResultsAccountsTab"
                | "UserProfile"
                | "MyProfile"
                | "EditProfile"
                | "EditProfileBio"
                | "EditProfileUsername"
                | "EditProfileLinks"
                | "EditProfileAddLink"
                | "ProfilePostsFeed"
                | "FeedTimelineFollowing"
                | "UserProfileReelsTab"
                | "DirectInbox"
                | "DirectRecipientPicker"
                | "DirectThread"
                | "DirectCustomizeChat"
                | "DirectThreadThemePicker"
                | "DirectThreadDetails"
                | "DirectThreadSharedMedia"
                | "DirectThreadNicknameChange"
                | "DirectGroupNameAndPhotoEditor"
                | "PostingGalleryPicker"
                | "PostingPostEdit"
                | "PostingNewPost"
                | "PostingCamera"
                | "PostingCameraGallery"
                | "PostingReelEditor"
                | "PostingNewReel"
                | "PostingStoryPhotoEditor"
                | "PostingStoryVideoEditor"
                | "PostingStoryStickerTray"
                | "PostingStoryMusicStickerEditor"
                | "PostingStoryShareSheet"
                | "PostingStoryAlsoShareTo"
                | "PostingMusicBrowser"
                | "PostingMusicSearchResults"
                | "PostingReelMusicEditor"
                | "ChallengeSelectVerifyMethod"
                | "ChallengeVerifyCode"
                | "ChallengeSubmitPhone"
                | "ChallengeSetNewPassword"
                | "ChallengeAddBirthday"
                | "ChallengeLoginReview"
                | "ChallengeAccountTemporarilyLocked"
                | "ChallengeEscalationInformation"
                | "ChallengeReviewContactPointChange"
                | "ChallengeScrapingWarning"
                | "ChallengeWebRecaptcha"
                | "ChallengeWebSetNewPassword"
                | "ChallengeTextCaptcha"
                | "ChallengeRecaptcha"
                | "ChallengeSetContactPoint"
                | "ChallengeContactPointCode"
                | "ChallengeAuthenticityWizard"
                | "ChallengeAwaitingReview"
                | "ChallengeThanksForProvidingInfo"
                | "ChallengeAccountSuspended",
            State,
            Args extends readonly unknown[],
            Step extends ScreenEdgeStep<unknown>,
        >(
            id: Id,
            step: (state: State, ...args: NoInfer) => Step,
            args: ScreenCodec<Args>,
        ): (
            self: ScreenHandle,
            state: State,
        ) => ScreenEdgeBound<
            ScreenEdgeShape<
                AndroidScreens[Id],
                Args,
                Step["source"],
                AndroidScreens,
            >,
            ScreenEdgeCall<
                AndroidScreens[Id],
                Args,
                Step["input"],
                AndroidScreens,
                Step["source"],
            >,
        >
      • A transition into the screen id: calling it runs the target's enter and returns the target's handle, whose origin is the handle the edge was taken from (none for a tab). step maps the screen's state (and the caller's arguments) to the edge's source, ordinal skip and the target's input. An edge that takes arguments declares their schema (a tuple) third, so a trail can store them.

        The edge is taken only while its screen is on top (an item's: while its host is), else it dies with ScreenNotOnTopError (a defect); an input the target's schema refuses is ScreenEdgeInputError.

        The target's handle is typed by the registry, not by the handle the edge is taken from: its origin is what can open the target (ScreenOpenersOf, ScreenItemOpenersOf), so an action that takes its own screen's edge (handleAction) uses this same declaration.

        Type Parameters

        • const Id extends
              | "LoginHomepage"
              | "LoginTwoFactorEntrypoint"
              | "LoginTwoFactorMethodPicker"
              | "LoginTwoFactorEnterTotpCode"
              | "AccountRecoverySearch"
              | "AccountRecoveryAuthenticationConfirmation"
              | "AccountRecoveryEmailCode"
              | "RegistrationPhoneNumber"
              | "RegistrationConfirmationCode"
              | "RegistrationPassword"
              | "RegistrationBirthday"
              | "RegistrationName"
              | "RegistrationUsername"
              | "RegistrationTermsOfService"
              | "AccountRecoverySuccessLocationPermission"
              | "FeedTimeline"
              | "PostOpenedFromLink"
              | "ReelsViewer"
              | "MediaComments"
              | "RepostNoteEditor"
              | "Explore"
              | "SearchInput"
              | "SearchResultsTopTab"
              | "SearchResultsAccountsTab"
              | "UserProfile"
              | "MyProfile"
              | "EditProfile"
              | "EditProfileBio"
              | "EditProfileUsername"
              | "EditProfileLinks"
              | "EditProfileAddLink"
              | "ProfilePostsFeed"
              | "FeedTimelineFollowing"
              | "UserProfileReelsTab"
              | "DirectInbox"
              | "DirectRecipientPicker"
              | "DirectThread"
              | "DirectCustomizeChat"
              | "DirectThreadThemePicker"
              | "DirectThreadDetails"
              | "DirectThreadSharedMedia"
              | "DirectThreadNicknameChange"
              | "DirectGroupNameAndPhotoEditor"
              | "PostingGalleryPicker"
              | "PostingPostEdit"
              | "PostingNewPost"
              | "PostingCamera"
              | "PostingCameraGallery"
              | "PostingReelEditor"
              | "PostingNewReel"
              | "PostingStoryPhotoEditor"
              | "PostingStoryVideoEditor"
              | "PostingStoryStickerTray"
              | "PostingStoryMusicStickerEditor"
              | "PostingStoryShareSheet"
              | "PostingStoryAlsoShareTo"
              | "PostingMusicBrowser"
              | "PostingMusicSearchResults"
              | "PostingReelMusicEditor"
              | "ChallengeSelectVerifyMethod"
              | "ChallengeVerifyCode"
              | "ChallengeSubmitPhone"
              | "ChallengeSetNewPassword"
              | "ChallengeAddBirthday"
              | "ChallengeLoginReview"
              | "ChallengeAccountTemporarilyLocked"
              | "ChallengeEscalationInformation"
              | "ChallengeReviewContactPointChange"
              | "ChallengeScrapingWarning"
              | "ChallengeWebRecaptcha"
              | "ChallengeWebSetNewPassword"
              | "ChallengeTextCaptcha"
              | "ChallengeRecaptcha"
              | "ChallengeSetContactPoint"
              | "ChallengeContactPointCode"
              | "ChallengeAuthenticityWizard"
              | "ChallengeAwaitingReview"
              | "ChallengeThanksForProvidingInfo"
              | "ChallengeAccountSuspended"
        • State
        • Args extends readonly unknown[]
        • Step extends ScreenEdgeStep<unknown>

        Parameters

        Returns (
            self: ScreenHandle,
            state: State,
        ) => ScreenEdgeBound<
            ScreenEdgeShape<
                AndroidScreens[Id],
                Args,
                Step["source"],
                AndroidScreens,
            >,
            ScreenEdgeCall<
                AndroidScreens[Id],
                Args,
                Step["input"],
                AndroidScreens,
                Step["source"],
            >,
        >