xref: /expo/docs/public/static/data/unversioned/expo-application.json (revision da751fd5)

{"name":"expo-application","kind":1,"children":[{"name":"ApplicationReleaseType","kind":8,"children":[{"name":"AD_HOC","kind":16,"type":{"type":"literal","value":4}},{"name":"APP_STORE","kind":16,"type":{"type":"literal","value":5}},{"name":"DEVELOPMENT","kind":16,"type":{"type":"literal","value":3}},{"name":"ENTERPRISE","kind":16,"type":{"type":"literal","value":2}},{"name":"SIMULATOR","kind":16,"type":{"type":"literal","value":1}},{"name":"UNKNOWN","kind":16,"type":{"type":"literal","value":0}}]},{"name":"PushNotificationServiceEnvironment","kind":4194304,"type":{"type":"union","types":[{"type":"literal","value":"development"},{"type":"literal","value":"production"},{"type":"literal","value":null}]}},{"name":"androidId","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"The value of ["},{"kind":"code","text":"`Settings.Secure.ANDROID_ID`"},{"kind":"text","text":"](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID).\nThis is a hexadecimal "},{"kind":"code","text":"`string`"},{"kind":"text","text":" unique to each combination of app-signing key, user, and device.\nThe value may change if a factory reset is performed on the device or if an APK signing key changes.\nFor more information about how the platform handles "},{"kind":"code","text":"`ANDROID_ID`"},{"kind":"text","text":" in Android 8.0 (API level 26)\nand higher, see [Android 8.0 Behavior Changes](https://developer.android.com/about/versions/oreo/android-8.0-changes.html#privacy-all).\nOn iOS and web, this value is "},{"kind":"code","text":"`null`"},{"kind":"text","text":".\n> In versions of the platform lower than Android 8.0 (API level 26), this value remains constant\n> for the lifetime of the user's device. See the [ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID)\n> official docs for more information."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"`\"dd96dec43fb81c97\"`"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]},"defaultValue":"..."},{"name":"applicationId","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"The ID of the application. On Android, this is the application ID. On iOS, this is the bundle ID.\nOn web, this is "},{"kind":"code","text":"`null`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"`\"com.cocoacasts.scribbles\"`"},{"kind":"text","text":", "},{"kind":"code","text":"`\"com.apple.Pages\"`"}]}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]},"defaultValue":"..."},{"name":"applicationName","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"The human-readable name of the application that is displayed with the app's icon on the device's\nhome screen or desktop. On Android and iOS, this value is a "},{"kind":"code","text":"`string`"},{"kind":"text","text":" unless the name could not be\nretrieved, in which case this value will be "},{"kind":"code","text":"`null`"},{"kind":"text","text":". On web this value is "},{"kind":"code","text":"`null`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"`\"Expo\"`"},{"kind":"text","text":", "},{"kind":"code","text":"`\"Yelp\"`"},{"kind":"text","text":", "},{"kind":"code","text":"`\"Instagram\"`"}]}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]},"defaultValue":"..."},{"name":"nativeApplicationVersion","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"The human-readable version of the native application that may be displayed in the app store.\nThis is the "},{"kind":"code","text":"`Info.plist`"},{"kind":"text","text":" value for "},{"kind":"code","text":"`CFBundleShortVersionString`"},{"kind":"text","text":" on iOS and the version name set\nby "},{"kind":"code","text":"`version`"},{"kind":"text","text":" in "},{"kind":"code","text":"`app.json`"},{"kind":"text","text":" on Android at the time the native app was built.\nOn web, this value is "},{"kind":"code","text":"`null`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"`\"2.11.0\"`"}]}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]},"defaultValue":"..."},{"name":"nativeBuildVersion","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"The internal build version of the native application that the app store may use to distinguish\nbetween different binaries. This is the "},{"kind":"code","text":"`Info.plist`"},{"kind":"text","text":" value for "},{"kind":"code","text":"`CFBundleVersion`"},{"kind":"text","text":" on iOS (set with\n"},{"kind":"code","text":"`ios.buildNumber`"},{"kind":"text","text":" value in "},{"kind":"code","text":"`app.json`"},{"kind":"text","text":" in a standalone app) and the version code set by\n"},{"kind":"code","text":"`android.versionCode`"},{"kind":"text","text":" in "},{"kind":"code","text":"`app.json`"},{"kind":"text","text":" on Android at the time the native app was built. On web, this\nvalue is "},{"kind":"code","text":"`null`"},{"kind":"text","text":". The return type on Android and iOS is "},{"kind":"code","text":"`string`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"text","text":"iOS: "},{"kind":"code","text":"`\"2.11.0\"`"},{"kind":"text","text":", Android: "},{"kind":"code","text":"`\"114\"`"}]}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]},"defaultValue":"..."},{"name":"getInstallReferrerAsync","kind":64,"signatures":[{"name":"getInstallReferrerAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets the referrer URL of the installed app with the ["},{"kind":"code","text":"`Install Referrer API`"},{"kind":"text","text":"](https://developer.android.com/google/play/installreferrer)\nfrom the Google Play Store. In practice, the referrer URL may not be a complete, absolute URL."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A "},{"kind":"code","text":"`Promise`"},{"kind":"text","text":" that fulfills with a "},{"kind":"code","text":"`string`"},{"kind":"text","text":" of the referrer URL of the installed app."}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\nawait Application.getInstallReferrerAsync();\n// \"utm_source=google-play&utm_medium=organic\"\n```"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"getInstallationTimeAsync","kind":64,"signatures":[{"name":"getInstallationTimeAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets the time the app was installed onto the device, not counting subsequent updates. If the app\nis uninstalled and reinstalled, this method returns the time the app was reinstalled.\n- On iOS, this method uses the ["},{"kind":"code","text":"`NSFileCreationDate`"},{"kind":"text","text":"](https://developer.apple.com/documentation/foundation/nsfilecreationdate?language=objc)\nof the app's document root directory.\n- On Android, this method uses ["},{"kind":"code","text":"`PackageInfo.firstInstallTime`"},{"kind":"text","text":"](https://developer.android.com/reference/android/content/pm/PackageInfo.html#firstInstallTime).\n- On web, this method returns "},{"kind":"code","text":"`null`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a "},{"kind":"code","text":"`Promise`"},{"kind":"text","text":" that fulfills with a "},{"kind":"code","text":"`Date`"},{"kind":"text","text":" object that specifies the time the app\nwas installed on the device."}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\nawait Application.getInstallationTimeAsync();\n// 2019-07-18T18:08:26.121Z\n```"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Date","qualifiedName":"Date","package":"typescript"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"getIosApplicationReleaseTypeAsync","kind":64,"signatures":[{"name":"getIosApplicationReleaseTypeAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets the iOS application release type."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a promise which fulfills with an ["},{"kind":"code","text":"`ApplicationReleaseType`"},{"kind":"text","text":"](#applicationreleasetype)."}]},{"tag":"@platform","content":[{"kind":"text","text":"ios"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","name":"ApplicationReleaseType"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"getIosIdForVendorAsync","kind":64,"signatures":[{"name":"getIosIdForVendorAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets the iOS \"identifier for vendor\" ([IDFV](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor))\nvalue, a string ID that uniquely identifies a device to the app’s vendor. This method may\nsometimes return "},{"kind":"code","text":"`nil`"},{"kind":"text","text":", in which case wait and call the method again later. This might happen\nwhen the device has been restarted before the user has unlocked the device.\n\nThe OS will change the vendor identifier if all apps from the current app's vendor have been\nuninstalled."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A "},{"kind":"code","text":"`Promise`"},{"kind":"text","text":" that fulfills with a "},{"kind":"code","text":"`string`"},{"kind":"text","text":" specifying the app's vendor ID. Apps from the\nsame vendor will return the same ID. See Apple's documentation for more information about the\nvendor ID's semantics."}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\nawait Application.getIosIdForVendorAsync();\n// \"68753A44-4D6F-1226-9C60-0050E4C00067\"\n```"}]},{"tag":"@platform","content":[{"kind":"text","text":"ios"}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"getIosPushNotificationServiceEnvironmentAsync","kind":64,"signatures":[{"name":"getIosPushNotificationServiceEnvironmentAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets the current [Apple Push Notification (APN)](https://developer.apple.com/documentation/bundleresources/entitlements/aps-environment?language=objc)\nservice environment."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a promise fulfilled with the string, either "},{"kind":"code","text":"`'development'`"},{"kind":"text","text":" or "},{"kind":"code","text":"`'production'`"},{"kind":"text","text":",\nbased on the current APN environment, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" on the simulator as it does not support registering with APNs."}]},{"tag":"@platform","content":[{"kind":"text","text":"ios"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","name":"PushNotificationServiceEnvironment"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"getLastUpdateTimeAsync","kind":64,"signatures":[{"name":"getLastUpdateTimeAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets the last time the app was updated from the Google Play Store."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a "},{"kind":"code","text":"`Promise`"},{"kind":"text","text":" that fulfills with a "},{"kind":"code","text":"`Date`"},{"kind":"text","text":" object that specifies the last time\nthe app was updated via the Google Play Store)."}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\nawait Application.getLastUpdateTimeAsync();\n// 2019-07-18T21:20:16.887Z\n```"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Date","qualifiedName":"Date","package":"typescript"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]}]}