API reference
OVR_Message.h File
Represents a response from the backend with a typed and structured model payload. See more details here. Your app should constantly check the message queue for messages from the Platform SDK. We recommend that you check the queue every frame for new messages.
Typedefs
struct ovrMessage * ovrMessageHandle
Functions
ovrAbuseReportRecordingHandle ovr_Message_GetAbuseReportRecording
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAbuseReportRecording. Intended to be used by clients to handle the structured payload.
ovrAchievementDefinitionArrayHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrAchievementProgressArrayHandle ovr_Message_GetAchievementProgressArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAchievementProgressArray. Intended to be used by clients to handle the structured payload.
ovrAchievementUpdateHandle ovr_Message_GetAchievementUpdate
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAchievementUpdate. Intended to be used by clients to handle the structured payload.
ovrAppDownloadProgressResultHandle ovr_Message_GetAppDownloadProgressResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAppDownloadProgressResult. Intended to be used by clients to handle the structured payload.
ovrAppDownloadResultHandle ovr_Message_GetAppDownloadResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAppDownloadResult. Intended to be used by clients to handle the structured payload.
ovrApplicationInviteArrayHandle ovr_Message_GetApplicationInviteArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetApplicationInviteArray. Intended to be used by clients to handle the structured payload.
ovrApplicationVersionHandle ovr_Message_GetApplicationVersion
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetApplicationVersion. Intended to be used by clients to handle the structured payload.
ovrAssetDetailsHandle ovr_Message_GetAssetDetails
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAssetDetails. Intended to be used by clients to handle the structured payload.
ovrAssetDetailsArrayHandle ovr_Message_GetAssetDetailsArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAssetDetailsArray. Intended to be used by clients to handle the structured payload.
ovrAssetFileDeleteResultHandle ovr_Message_GetAssetFileDeleteResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAssetFileDeleteResult. Intended to be used by clients to handle the structured payload.
ovrAssetFileDownloadCancelResultHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrAssetFileDownloadResultHandle ovr_Message_GetAssetFileDownloadResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAssetFileDownloadResult. Intended to be used by clients to handle the structured payload.
ovrAssetFileDownloadUpdateHandle ovr_Message_GetAssetFileDownloadUpdate
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAssetFileDownloadUpdate. Intended to be used by clients to handle the structured payload.
ovrAvatarEditorResultHandle ovr_Message_GetAvatarEditorResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetAvatarEditorResult. Intended to be used by clients to handle the structured payload.
ovrBlockedUserArrayHandle ovr_Message_GetBlockedUserArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetBlockedUserArray. Intended to be used by clients to handle the structured payload.
ovrChallengeHandle ovr_Message_GetChallenge
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetChallenge. Intended to be used by clients to handle the structured payload.
ovrChallengeArrayHandle ovr_Message_GetChallengeArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetChallengeArray. Intended to be used by clients to handle the structured payload.
ovrChallengeEntryArrayHandle ovr_Message_GetChallengeEntryArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetChallengeEntryArray. Intended to be used by clients to handle the structured payload.
ovrCowatchViewerArrayHandle ovr_Message_GetCowatchViewerArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetCowatchViewerArray. Intended to be used by clients to handle the structured payload.
ovrCowatchViewerUpdateHandle ovr_Message_GetCowatchViewerUpdate
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetCowatchViewerUpdate. Intended to be used by clients to handle the structured payload.
ovrCowatchingStateHandle ovr_Message_GetCowatchingState
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetCowatchingState. Intended to be used by clients to handle the structured payload.
ovrDataStoreHandle ovr_Message_GetDataStore
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetDataStore. Intended to be used by clients to handle the structured payload.
ovrDestinationArrayHandle ovr_Message_GetDestinationArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetDestinationArray. Intended to be used by clients to handle the structured payload.
ovrErrorHandle ovr_Message_GetError
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetError. Intended to be used by clients to handle the structured payload.
ovrGroupPresenceJoinIntentHandle ovr_Message_GetGroupPresenceJoinIntent
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetGroupPresenceJoinIntent. Intended to be used by clients to handle the structured payload.
ovrGroupPresenceLeaveIntentHandle ovr_Message_GetGroupPresenceLeaveIntent
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetGroupPresenceLeaveIntent. Intended to be used by clients to handle the structured payload.
ovrHttpTransferUpdateHandle ovr_Message_GetHttpTransferUpdate
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetHttpTransferUpdate. Intended to be used by clients to handle the structured payload.
ovrInstalledApplicationArrayHandle ovr_Message_GetInstalledApplicationArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetInstalledApplicationArray. Intended to be used by clients to handle the structured payload.
ovrInvitePanelResultInfoHandle ovr_Message_GetInvitePanelResultInfo
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetInvitePanelResultInfo. Intended to be used by clients to handle the structured payload.
ovrLaunchBlockFlowResultHandle ovr_Message_GetLaunchBlockFlowResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLaunchBlockFlowResult. Intended to be used by clients to handle the structured payload.
ovrLaunchFriendRequestFlowResultHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrLaunchInvitePanelFlowResultHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrLaunchReportFlowResultHandle ovr_Message_GetLaunchReportFlowResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLaunchReportFlowResult. Intended to be used by clients to handle the structured payload.
ovrLaunchUnblockFlowResultHandle ovr_Message_GetLaunchUnblockFlowResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLaunchUnblockFlowResult. Intended to be used by clients to handle the structured payload.
ovrLeaderboardArrayHandle ovr_Message_GetLeaderboardArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLeaderboardArray. Intended to be used by clients to handle the structured payload.
ovrLeaderboardEntryArrayHandle ovr_Message_GetLeaderboardEntryArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLeaderboardEntryArray. Intended to be used by clients to handle the structured payload.
ovrLeaderboardUpdateStatusHandle ovr_Message_GetLeaderboardUpdateStatus
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLeaderboardUpdateStatus. Intended to be used by clients to handle the structured payload.
ovrLinkedAccountArrayHandle ovr_Message_GetLinkedAccountArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLinkedAccountArray. Intended to be used by clients to handle the structured payload.
ovrLivestreamingApplicationStatusHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrLivestreamingStartResultHandle ovr_Message_GetLivestreamingStartResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLivestreamingStartResult. Intended to be used by clients to handle the structured payload.
ovrLivestreamingStatusHandle ovr_Message_GetLivestreamingStatus
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLivestreamingStatus. Intended to be used by clients to handle the structured payload.
ovrLivestreamingVideoStatsHandle ovr_Message_GetLivestreamingVideoStats
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetLivestreamingVideoStats. Intended to be used by clients to handle the structured payload.
ovrMicrophoneAvailabilityStateHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrMessageHandle ovr_Message_GetNativeMessage
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetNativeMessage. Intended to be used by clients to handle the structured payload.
ovrNetSyncConnectionHandle ovr_Message_GetNetSyncConnection
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetNetSyncConnection. Intended to be used by clients to handle the structured payload.
ovrNetSyncSessionArrayHandle ovr_Message_GetNetSyncSessionArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetNetSyncSessionArray. Intended to be used by clients to handle the structured payload.
ovrNetSyncSessionsChangedNotificationHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrNetSyncSetSessionPropertyResultHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrNetSyncVoipAttenuationValueArrayHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrOrgScopedIDHandle ovr_Message_GetOrgScopedID
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetOrgScopedID. Intended to be used by clients to handle the structured payload.
ovrPartyHandle ovr_Message_GetParty
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetParty. Intended to be used by clients to handle the structured payload.
ovrPartyIDHandle ovr_Message_GetPartyID
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetPartyID. Intended to be used by clients to handle the structured payload.
ovrPartyUpdateNotificationHandle ovr_Message_GetPartyUpdateNotification
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetPartyUpdateNotification. Intended to be used by clients to handle the structured payload.
ovrPidArrayHandle ovr_Message_GetPidArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetPidArray. Intended to be used by clients to handle the structured payload.
ovrPlatformInitializeHandle ovr_Message_GetPlatformInitialize
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetPlatformInitialize. Intended to be used by clients to handle the structured payload.
ovrProductArrayHandle ovr_Message_GetProductArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetProductArray. Intended to be used by clients to handle the structured payload.
ovrPurchaseHandle ovr_Message_GetPurchase
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetPurchase. Intended to be used by clients to handle the structured payload.
ovrPurchaseArrayHandle ovr_Message_GetPurchaseArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetPurchaseArray. Intended to be used by clients to handle the structured payload.
ovrRejoinDialogResultHandle ovr_Message_GetRejoinDialogResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetRejoinDialogResult. Intended to be used by clients to handle the structured payload.
ovrRequest ovr_Message_GetRequestID
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetRequestID. Intended to be used by clients to handle the structured payload.
ovrSdkAccountArrayHandle ovr_Message_GetSdkAccountArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetSdkAccountArray. Intended to be used by clients to handle the structured payload.
ovrSendInvitesResultHandle ovr_Message_GetSendInvitesResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetSendInvitesResult. Intended to be used by clients to handle the structured payload.
ovrShareMediaResultHandle ovr_Message_GetShareMediaResult
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetShareMediaResult. Intended to be used by clients to handle the structured payload.
const char * ovr_Message_GetString
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetString. Intended to be used by clients to handle the structured payload.
ovrSystemVoipStateHandle ovr_Message_GetSystemVoipState
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetSystemVoipState. Intended to be used by clients to handle the structured payload.
ovrMessageType ovr_Message_GetType
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetType. Intended to be used by clients to handle the structured payload.
ovrUserHandle ovr_Message_GetUser
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetUser. Intended to be used by clients to handle the structured payload.
ovrUserAccountAgeCategoryHandle ovr_Message_GetUserAccountAgeCategory
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetUserAccountAgeCategory. Intended to be used by clients to handle the structured payload.
ovrUserArrayHandle ovr_Message_GetUserArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetUserArray. Intended to be used by clients to handle the structured payload.
ovrUserCapabilityArrayHandle ovr_Message_GetUserCapabilityArray
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetUserCapabilityArray. Intended to be used by clients to handle the structured payload.
ovrUserDataStoreUpdateResponseHandle ovr_
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_
ovrUserProofHandle ovr_Message_GetUserProof
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetUserProof. Intended to be used by clients to handle the structured payload.
ovrUserReportIDHandle ovr_Message_GetUserReportID
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_GetUserReportID. Intended to be used by clients to handle the structured payload.
bool ovr_Message_IsError
( const ovrMessageHandle obj )
Retrieves the model payload from the response ovr_Message_IsError. Intended to be used by clients to handle the structured payload.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta