Develop

Test with Platform SDK

Updated: Sep 5, 2026

VR Platform SDK is offered in a set of Kotlin packages you can integrate in your Android app. Each of these features can be used independently, but using multiple in combination provides more engaging VR experiences.

VR Platform SDK is supported on Meta Spatial Simulator as a sandbox for testing Platform SDK APIs with local sample data and supported backend requests. For more information about the test environment, see Spatial Simulator test environment.

Additional interactions to the environment are available via a command-line interface (CLI). For more information about the CLI, see Spatial Simulator CLI.

To test Platform SDK APIs that make backend requests, see Sign in to the simulator.

To reset local sample data to its default state, run:

adb shell "am broadcast -n horizon.platform.spatialsim/.CommandReceiver --es COMMAND \"common.reset_data\""

Supported features

Spatial Simulator supports the Platform SDK APIs listed below, but support is not universal.

The tables use four standard labels for recurring simulator behavior. A row that also opens a dialog states that after the label. A row whose behavior does not fit a label describes it in full.

Backend request: Calls the Meta backend when you are signed in. Returns an authentication error when signed out.
Fixed response: Returns a fixed response. Does not evaluate the request.
Saved locally: Reads and writes local sample data. Persists across calls.
adb event: Delivers a result only when you send the event over adb.

Group Presence

Use Group Presence to add multiplayer features and presence to your Android apps.

API	Behavior in Spatial Simulator
`GroupPresence.set`	Saved locally.
`GroupPresence.setDestination`	Saved locally.
`GroupPresence.setIsJoinable`	Saved locally.
`GroupPresence.setLobbySession`	Saved locally.
`GroupPresence.setMatchSession`	Saved locally.
`GroupPresence.setDeeplinkMessageOverride`	Saved locally.
`GroupPresence.clear`	Saved locally.
`GroupPresence.getInvitableUsers`	Backend request.
`GroupPresence.getSentInvites`	Backend request.
`GroupPresence.sendInvites`	Backend request.
`GroupPresence.getDestinations`	Backend request.
`GroupPresence.launchInvitePanel`	Fixed response. Opens a simulated dialog.
`GroupPresence.launchRosterPanel`	Fixed response. Opens a simulated dialog.
`GroupPresence.launchRejoinDialog`	Saved locally. Opens a simulated dialog.
`GroupPresence.launchMultiplayerErrorDialog`	Fixed response. Opens a simulated dialog.
`GroupPresence.joinIntentReceived`	adb event.
`GroupPresence.invitationsSent`	adb event.

IAP (In-App Purchases)

API	Behavior in Spatial Simulator
`Iap.getProductsBySku`	Backend request.
`Iap.launchCheckoutFlow`	Saved locally. Opens a simulated dialog unless the SKU has already been purchased.
`Iap.getViewerPurchases`	Saved locally.
`Iap.getViewerPurchasesDurableCache`	Saved locally.
`Iap.consumePurchase`	Backend request.

Rate and Review

API	Behavior in Spatial Simulator
`RateAndReview.canLaunchRateAndReview`	Backend request.
`RateAndReview.rateAndReviewLauncher`	Fixed response.

Notifications

API	Behavior in Spatial Simulator
`Notifications.deviceNotification`	Opens a simulated dialog that previews a notification with example action icons when `actionIcon` is set, or an in-headset notification toast otherwise.

Users

API	Behavior in Spatial Simulator
`Users.get`	Backend request.
`Users.getAccessToken`	Returns the current access token when signed in. Fixed response when signed out.
`Users.getLoggedInUser`	Backend request when signed in. Fixed response when signed out.
`Users.getLoggedInUserFriends`	Backend request.
`Users.getLoggedInUserManagedInfo`	Backend request.
`Users.getBlockedUsers`	Backend request.
`Users.getUserProof`	Backend request.
`Users.getOrgScopedId`	Backend request.
`Users.getSdkAccounts`	Backend request.
`Users.getLinkedAccounts`	Fixed response.
`Users.launchBlockFlow`	Saved locally. Opens a simulated dialog.
`Users.launchUnblockFlow`	Saved locally. Opens a simulated dialog.
`Users.sendAuthUrl`	Fixed response.

Application

API	Behavior in Spatial Simulator
`Application.launchOtherApp`	Fixed response. Opens a simulated dialog.
`Application.getVersion`	Returns the installed version of the calling app. Reports that version as both current and latest.
`Application.startAppDownload`	Saved locally.
`Application.checkAppDownloadProgress`	Saved locally.
`Application.cancelAppDownload`	Saved locally.
`Application.installAppUpdateAndRelaunch`	Saved locally.

Application Lifecycle

API	Behavior in Spatial Simulator
`ApplicationLifecycle.launchIntentChanged`	adb event.
`ApplicationLifecycle.getLaunchDetails`	Fixed response.
`ApplicationLifecycle.logDeeplinkResult`	Fixed response.

User Age Category

API	Behavior in Spatial Simulator
`UserAgeCategory.get`	Backend request.

Asset File

Use Asset File to manage downloadable content and language packs for your Android apps.

API	Behavior in Spatial Simulator
`AssetFile.getList`	Saved locally.
`AssetFile.statusById`	Saved locally.
`AssetFile.statusByName`	Saved locally.
`AssetFile.downloadById`	Saved locally.
`AssetFile.downloadByName`	Saved locally.
`AssetFile.downloadByIdList`	Saved locally.
`AssetFile.downloadByNameList`	Saved locally.
`AssetFile.downloadCancelById`	Saved locally.
`AssetFile.downloadCancelByName`	Saved locally.
`AssetFile.deleteById`	Saved locally.
`AssetFile.deleteByName`	Saved locally.
`AssetFile.downloadUpdate`	Receives progress updates from simulated downloads and the `asset_file.download_update` adb event.

Language Pack

Use Language Pack to manage localized content and language switching for your Android apps. Language Pack APIs work in conjunction with Asset File APIs - language packs are stored as assets with assetType of language_pack.

API	Behavior in Spatial Simulator
`LanguagePack.getCurrent`	Saved locally.
`LanguagePack.setCurrent`	Saved locally.

API	Behavior in Spatial Simulator
`Consent.getConsentStatus`	Fixed response.
`Consent.launchConsentIfRequired`	Fixed response. Opens a simulated dialog.

Achievements

API	Behavior in Spatial Simulator
`Achievements.getAllDefinitions`	Backend request.
`Achievements.getDefinitionsByName`	Backend request.
`Achievements.getAllProgress`	Backend request.
`Achievements.getProgressByName`	Backend request.
`Achievements.addCount`	Fixed response.
`Achievements.addFields`	Backend request.
`Achievements.unlock`	Backend request.

Leaderboards

API	Behavior in Spatial Simulator
`Leaderboards.get`	Backend request.
`Leaderboards.getEntries`	Backend request.
`Leaderboards.getEntriesAfterRank`	Backend request.
`Leaderboards.getEntriesByIds`	Backend request.
`Leaderboards.writeEntry`	Backend request.
`Leaderboards.writeEntryWithSupplementaryMetric`	Backend request.

Abuse Report

API	Behavior in Spatial Simulator
`AbuseReport.reportRequestHandled`	Accepts a valid response value without changing simulator state. Invalid request data returns an error.

Device Application Integrity

Use Device Application Integrity to verify device and application integrity for your Android apps.

API	Behavior in Spatial Simulator
`DeviceApplicationIntegrity.getIntegrityToken`	Checks the nonce length and allowed characters, then returns a fixed simulated integrity token. Does not perform real integrity verification.

Known limitations

Other known limitations of the VR Platform SDK integration on Spatial Simulator include:

Local sample data remains keyed to the seeded test user, Sir Lancelot.
The database cannot be cleared entirely. It can only be reset to its default state using CLI commands.
UI dialogs are simplified simulations of the actual device experience.
Some APIs use local sample data. See the tables above for the behavior of each API.