Home > @snowplow/react-native-tracker > PlatformContextRetriever
Overrides for the values for properties of the platform context.
Signature:
export interface PlatformContextRetriever | Property | Type | Description |
|---|---|---|
| getAndroidIdfa? | () => Promise<string | undefined> | (Optional) Advertising identifier on Android. |
| getAppAvailableMemory? | () => Promise<number | undefined> | (Optional) Amount of memory in bytes available to the current app |
| getAppleIdfa? | () => Promise<string | undefined> | (Optional) Advertising identifier on iOS (UUID formatted string) |
| getAppleIdfv? | () => Promise<string | undefined> | (Optional) UUID identifier for vendors on iOS |
| getAppSetId? | () => Promise<string | undefined> | (Optional) Android vendor ID scoped to the set of apps published under the same Google Play developer account (see https://developer.android.com/training/articles/app-set-id). |
| getAppSetIdScope? | () => Promise<string | undefined> | (Optional) Scope of the appSetId. Can be scoped to the app or to a developer account on an app store (all apps from the same developer on the same device will have the same ID). |
| getAvailableStorage? | () => Promise<number | undefined> | (Optional) Bytes of storage remaining |
| getBatteryLevel? | () => Promise<number | undefined> | (Optional) Remaining battery level as an integer percentage of total battery capacity |
| getBatteryState? | () => Promise<'unplugged' | 'charging' | 'full' | undefined> | (Optional) Battery state for the device |
| getCarrier? | () => Promise<string | undefined> | (Optional) The carrier of the SIM inserted in the device |
| getDeviceManufacturer? | () => Promise<string> | (Optional) The manufacturer of the product/hardware |
| getDeviceModel? | () => Promise<string> | (Optional) The end-user-visible name for the end product |
| getLanguage? | () => Promise<string | undefined> | (Optional) System language currently used on the device (ISO 639) |
| getLowPowerMode? | () => Promise<boolean | undefined> | (Optional) A Boolean indicating whether Low Power Mode is enabled |
| getNetworkTechnology? | () => Promise<string | undefined> | (Optional) Radio access technology that the device is using |
| getNetworkType? | () => Promise<'mobile' | 'wifi' | 'offline' | undefined> | (Optional) Type of network the device is connected to |
| getOsType? | () => Promise<string> | (Optional) Operating system type (e.g., ios, tvos, watchos, osx, android) |
| getOsVersion? | () => Promise<string> | (Optional) The current version of the operating system |
| getPhysicalMemory? | () => Promise<number | undefined> | (Optional) Total physical system memory in bytes |
| getResolution? | () => Promise<string | undefined> | (Optional) Screen resolution in pixels. Arrives in the form of WIDTHxHEIGHT (e.g., 1200x900). Doesn't change when device orientation changes |
| getScale? | () => Promise<number | undefined> | (Optional) Scale factor used to convert logical coordinates to device coordinates of the screen (uses UIScreen.scale on iOS) |
| getSystemAvailableMemory? | () => Promise<number | undefined> | (Optional) Available memory on the system in bytes (Android only). |
| getTotalStorage? | () => Promise<number | undefined> | (Optional) Total size of storage in bytes |
| isPortrait? | () => Promise<boolean | undefined> | (Optional) A Boolean indicating whether the device orientation is portrait (either upright or upside down) |