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

    Function declareLaunch

    • Declares the launch: the first screen, the launch edge's source and ordinal skip, and — for a platform whose launch sends more than its first screen — the burst with its marks (firstScreen, and splashScreen when the declaration names a splash), the first screen's input from the launch input and, optionally, the splash screen the launch brings over the first one (a screen of the platform's set, its own source and input). The declaration sends nothing; OpenApp runs the burst, the first screen's own enter runs at the burst's firstScreen, and the splash's at its splashScreen. A burst that enters the splash and then leaves it covered dies (ScreenLaunchSplashNotOnTopError, a defect of the declaration).

      Without a burst the launch is the first screen alone and the caller's input is the screen's input.

      Type Parameters

      • Id extends
            | "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"
            | "DirectCustomizeChat"
            | "DirectThreadThemePicker"
            | "DirectThreadDetails"
            | "DirectThreadSharedMedia"
            | "DirectThreadNicknames"
            | "DirectThreadNicknameChange"
            | "DirectGroupNameAndPhotoEditor"
            | "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"
      • Kind extends EnterableScreenKind
      • Input
      • Data extends object
      • State
      • E
      • R
      • Actions extends object
      • Items extends object
      • Top extends PropertyKey

      Parameters

      Returns ScreenLaunch<
          Id,
          Kind,
          Input,
          Data,
          State,
          E,
          R,
          Actions,
          Items,
          Top,
          Input,
          LaunchFirstScreenFailure<E, Items>,
          LaunchFirstScreenServices<R, Items>,
      >

    • Declares the launch: the first screen, the launch edge's source and ordinal skip, and — for a platform whose launch sends more than its first screen — the burst with its marks (firstScreen, and splashScreen when the declaration names a splash), the first screen's input from the launch input and, optionally, the splash screen the launch brings over the first one (a screen of the platform's set, its own source and input). The declaration sends nothing; OpenApp runs the burst, the first screen's own enter runs at the burst's firstScreen, and the splash's at its splashScreen. A burst that enters the splash and then leaves it covered dies (ScreenLaunchSplashNotOnTopError, a defect of the declaration).

      Without a burst the launch is the first screen alone and the caller's input is the screen's input.

      Type Parameters

      • Id extends
            | "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"
            | "DirectCustomizeChat"
            | "DirectThreadThemePicker"
            | "DirectThreadDetails"
            | "DirectThreadSharedMedia"
            | "DirectThreadNicknames"
            | "DirectThreadNicknameChange"
            | "DirectGroupNameAndPhotoEditor"
            | "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"
      • Kind extends EnterableScreenKind
      • Input
      • Data extends object
      • State
      • E
      • R
      • Actions extends object
      • Items extends object
      • Top extends PropertyKey
      • LaunchInput
      • BE
      • BR
      • SplashId extends
            | "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"
            | "DirectCustomizeChat"
            | "DirectThreadThemePicker"
            | "DirectThreadDetails"
            | "DirectThreadSharedMedia"
            | "DirectThreadNicknames"
            | "DirectThreadNicknameChange"
            | "DirectGroupNameAndPhotoEditor"
            | "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" = never
      • SplashKind extends EnterableScreenKind = never
      • SplashInput = never
      • SplashData extends object = never
      • SplashState = never
      • SplashE = never
      • SplashR = never
      • SplashActions extends object = never
      • SplashItems extends object = never
      • SplashTop extends PropertyKey = never

      Parameters

      Returns ScreenLaunch<
          Id,
          Kind,
          Input,
          Data,
          State,
          E,
          R,
          Actions,
          Items,
          Top,
          LaunchInput,
          BE,
          BR,
          SplashId,
          SplashKind,
          SplashInput,
          SplashData,
          SplashState,
          SplashE,
          SplashR,
          SplashActions,
          SplashItems,
          SplashTop,
      >