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

    Interface ScreenBackTo

    Closes every frame above the nearest frame of the screen target as one transition and brings that frame back to the top — the app closing a whole flow at once (the story's "Done" leaves the camera, its gallery, the editor and the sheets in one step, not one screen at a time). The frames leave top first (each one's beforeLeave and leave), the chain gives back every entry they wrote, and only the frame left standing is brought back (its beforeResume and resume run once). It succeeds with that frame's handle.

    screen is the handle on top and must be in focus (ScreenNotOnTopError otherwise). target names a screen definition: the frame it closes down to is the nearest one below screen whose screen it is. A stack with no such frame below screen is the defect ScreenRootBackError, as is a call with nothing to close, refused before anything is emitted or changed. A tab's root is never closed this way (ScreenNotNavigableError); it can be the frame the flow returns to.

    • Type Parameters

      • E = never
      • R = never

      Parameters

      • screen: ScreenHandle
      • target: {
            id:
                | "LoginHomepage"
                | "LoginHomeCds"
                | "LandingScreen"
                | "LoginTwoFactorEntrypoint"
                | "LoginTwoFactorMethodPicker"
                | "LoginTwoFactorEnterTotpCode"
                | "AccountRecoverySearchCds"
                | "AccountRecoverySearch"
                | "AccountRecoveryAuthenticationConfirmation"
                | "AccountRecoveryEmailCode"
                | "RegistrationPhoneNumber"
                | "RegistrationConfirmationCode"
                | "RegistrationPassword"
                | "RegistrationBirthday"
                | "RegistrationName"
                | "RegistrationUsername"
                | "RegistrationTermsOfService"
                | "SaveCredentials"
                | "AccountRecoverySuccessLocationPermission"
                | "FeedTimeline"
                | "PostOpenedFromLink"
                | "ReelsViewer"
                | "MediaComments"
                | "RepostNoteEditor"
                | "Explore"
                | "SearchInput"
                | "SearchResultsTopTab"
                | "SearchResultsAccountsTab"
                | "UserProfile"
                | "ProfileMediaTab"
                | "MyProfile"
                | "MyProfileMediaTab"
                | "EditProfile"
                | "EditProfileBio"
                | "EditProfileUsername"
                | "EditProfileLinks"
                | "EditProfileAddLink"
                | "ProfilePostsFeed"
                | "FeedTimelineFollowing"
                | "UserProfileReelsTab"
                | "DirectInbox"
                | "DirectRecipientPicker"
                | "DirectThread"
                | "DirectForwardingSheet"
                | "DirectMediaPickerPhotos"
                | "DirectStickerTabTray"
                | "DirectGifTray"
                | "DirectStickerPickerGrid"
                | "DirectImagineLoading"
                | "DirectImagineCreation"
                | "DirectDoodleEditor"
                | "DirectCustomizeChat"
                | "DirectThreadThemePicker"
                | "DirectThreadDetails"
                | "DirectThreadSharedMedia"
                | "DirectThreadNicknames"
                | "DirectThreadNicknameChange"
                | "DirectGroupNameAndPhotoEditor"
                | "DirectShareSheet"
                | "StoriesViewer"
                | "PostingGalleryPicker"
                | "PostingPostEdit"
                | "PostingNewPost"
                | "PostingCamera"
                | "PostingCameraGallery"
                | "PostingReelEditor"
                | "PostingNewReel"
                | "PostingPostVideoCameraGallery"
                | "PostingPostVideoCamera"
                | "PostingReelCamera"
                | "PostingStoryCameraHost"
                | "PostingStoryCameraGallery"
                | "PostingPostVideoNewReel"
                | "PostingStoryPhotoEditor"
                | "PostingStoryVideoEditor"
                | "PostingStoryStickerTray"
                | "PostingStoryMusicStickerEditor"
                | "PostingStoryShareSheet"
                | "PostingStoryAlsoShareTo"
                | "PostingStoryDoneCamera"
                | "PostingStoryMusicSearchHost"
                | "PostingMusicBrowser"
                | "PostingMusicSearchResults"
                | "PostingReelMusicOverlayDetail"
                | "PostingReelMusicEditor"
                | "ChallengeSelectVerifyMethod"
                | "ChallengeVerifyCode"
                | "ChallengeSubmitPhone"
                | "ChallengeSetNewPassword"
                | "ChallengeAddBirthday"
                | "ChallengeLoginReview"
                | "ChallengeAccountTemporarilyLocked"
                | "ChallengeEscalationInformation"
                | "ChallengeReviewContactPointChange"
                | "ChallengeScrapingWarning"
                | "ChallengeWebRecaptcha"
                | "ChallengeWebSetNewPassword"
                | "ChallengeTextCaptcha"
                | "ChallengeRecaptcha"
                | "ChallengeSetContactPoint"
                | "ChallengeContactPointCode"
                | "ChallengeAuthenticityWizard"
                | "ChallengeAwaitingReview"
                | "ChallengeThanksForProvidingInfo"
                | "ChallengeAccountSuspended";
        }
      • through: ScreenBackToThrough<E, R>

      Returns Effect<
          ScreenFrameHandle,
          ScreenEnterConcurrentError
          | E,
          MobileNavigation | ScreenStack | R,
      >

    • Parameters

      • screen: ScreenHandle
      • target: {
            id:
                | "LoginHomepage"
                | "LoginHomeCds"
                | "LandingScreen"
                | "LoginTwoFactorEntrypoint"
                | "LoginTwoFactorMethodPicker"
                | "LoginTwoFactorEnterTotpCode"
                | "AccountRecoverySearchCds"
                | "AccountRecoverySearch"
                | "AccountRecoveryAuthenticationConfirmation"
                | "AccountRecoveryEmailCode"
                | "RegistrationPhoneNumber"
                | "RegistrationConfirmationCode"
                | "RegistrationPassword"
                | "RegistrationBirthday"
                | "RegistrationName"
                | "RegistrationUsername"
                | "RegistrationTermsOfService"
                | "SaveCredentials"
                | "AccountRecoverySuccessLocationPermission"
                | "FeedTimeline"
                | "PostOpenedFromLink"
                | "ReelsViewer"
                | "MediaComments"
                | "RepostNoteEditor"
                | "Explore"
                | "SearchInput"
                | "SearchResultsTopTab"
                | "SearchResultsAccountsTab"
                | "UserProfile"
                | "ProfileMediaTab"
                | "MyProfile"
                | "MyProfileMediaTab"
                | "EditProfile"
                | "EditProfileBio"
                | "EditProfileUsername"
                | "EditProfileLinks"
                | "EditProfileAddLink"
                | "ProfilePostsFeed"
                | "FeedTimelineFollowing"
                | "UserProfileReelsTab"
                | "DirectInbox"
                | "DirectRecipientPicker"
                | "DirectThread"
                | "DirectForwardingSheet"
                | "DirectMediaPickerPhotos"
                | "DirectStickerTabTray"
                | "DirectGifTray"
                | "DirectStickerPickerGrid"
                | "DirectImagineLoading"
                | "DirectImagineCreation"
                | "DirectDoodleEditor"
                | "DirectCustomizeChat"
                | "DirectThreadThemePicker"
                | "DirectThreadDetails"
                | "DirectThreadSharedMedia"
                | "DirectThreadNicknames"
                | "DirectThreadNicknameChange"
                | "DirectGroupNameAndPhotoEditor"
                | "DirectShareSheet"
                | "StoriesViewer"
                | "PostingGalleryPicker"
                | "PostingPostEdit"
                | "PostingNewPost"
                | "PostingCamera"
                | "PostingCameraGallery"
                | "PostingReelEditor"
                | "PostingNewReel"
                | "PostingPostVideoCameraGallery"
                | "PostingPostVideoCamera"
                | "PostingReelCamera"
                | "PostingStoryCameraHost"
                | "PostingStoryCameraGallery"
                | "PostingPostVideoNewReel"
                | "PostingStoryPhotoEditor"
                | "PostingStoryVideoEditor"
                | "PostingStoryStickerTray"
                | "PostingStoryMusicStickerEditor"
                | "PostingStoryShareSheet"
                | "PostingStoryAlsoShareTo"
                | "PostingStoryDoneCamera"
                | "PostingStoryMusicSearchHost"
                | "PostingMusicBrowser"
                | "PostingMusicSearchResults"
                | "PostingReelMusicOverlayDetail"
                | "PostingReelMusicEditor"
                | "ChallengeSelectVerifyMethod"
                | "ChallengeVerifyCode"
                | "ChallengeSubmitPhone"
                | "ChallengeSetNewPassword"
                | "ChallengeAddBirthday"
                | "ChallengeLoginReview"
                | "ChallengeAccountTemporarilyLocked"
                | "ChallengeEscalationInformation"
                | "ChallengeReviewContactPointChange"
                | "ChallengeScrapingWarning"
                | "ChallengeWebRecaptcha"
                | "ChallengeWebSetNewPassword"
                | "ChallengeTextCaptcha"
                | "ChallengeRecaptcha"
                | "ChallengeSetContactPoint"
                | "ChallengeContactPointCode"
                | "ChallengeAuthenticityWizard"
                | "ChallengeAwaitingReview"
                | "ChallengeThanksForProvidingInfo"
                | "ChallengeAccountSuspended";
        }

      Returns Effect<
          ScreenFrameHandle,
          ScreenEnterConcurrentError,
          MobileNavigation
          | ScreenStack,
      >