Meta Developers

API reference

API reference

Select your platform

No SDKs available

No versions available

FNetworkProtocolTypes

FOvrAbuseReportOptions

FOvrAbuseReportRecording

FOvrAchievementDefinition

FOvrAchievementDefinitionPages

FOvrAchievementProgress

FOvrAchievementProgressPages

FOvrAchievementUpdate

FOvrAdvancedAbuseReportOptions

FOvrAppDownloadProgressResult

FOvrAppDownloadResult

FOvrApplicationInvite

FOvrApplicationInvitePages

FOvrApplicationOptions

FOvrApplicationVersion

FOvrAssetDetails

FOvrAssetFileDeleteResult

FOvrAssetFileDownloadCancelResult

FOvrAssetFileDownloadResult

FOvrAssetFileDownloadUpdate

FOvrAvatarEditorOptions

FOvrAvatarEditorResult

FOvrBlockedUser

FOvrBlockedUserPages

FOvrChallengeEntry

FOvrChallengeEntryPages

FOvrChallengeOptions

FOvrChallengePages

FOvrCowatchViewer

FOvrCowatchViewerPages

FOvrCowatchViewerUpdate

FOvrCowatchingState

FOvrDestination

FOvrDestinationPages

FOvrGroupPresenceJoinIntent

FOvrGroupPresenceLeaveIntent

FOvrGroupPresenceOptions

FOvrHttpTransferUpdate

FOvrInstalledApplication

FOvrInviteOptions

FOvrInvitePanelResultInfo

FOvrLanguagePackInfo

FOvrLaunchBlockFlowResult

FOvrLaunchDetails

FOvrLaunchFriendRequestFlowResult

FOvrLaunchInvitePanelFlowResult

FOvrLaunchReportFlowResult

FOvrLaunchUnblockFlowResult

FOvrLeaderboard

FOvrLeaderboardEntry

FOvrLeaderboardEntryPages

FOvrLeaderboardPages

FOvrLeaderboardUpdateStatus

FOvrLinkedAccount

FOvrLivestreamingApplicationStatus

FOvrLivestreamingStartResult

FOvrLivestreamingStatus

FOvrLivestreamingVideoStats

FOvrMicrophoneAvailabilityState

FOvrMultiplayerErrorOptions

FOvrNetSyncConnection

FOvrNetSyncOptions

FOvrNetSyncSession

FOvrNetSyncSessionsChangedNotification

FOvrNetSyncSetSessionPropertyResult

FOvrNetSyncVoipAttenuationValue

FOvrOrgScopedID

FOvrPageRequestLatentAction

FOvrPartyUpdateNotification

FOvrPlatformInitialize

FOvrPlatformModule

FOvrPreemptableLatentAction

FOvrProductPages

FOvrPurchasePages

FOvrRejoinDialogResult

FOvrRequestLatentAction

FOvrRichPresenceOptions

FOvrRosterOptions

FOvrSendInvitesResult

FOvrShareMediaResult

FOvrSupplementaryMetric

FOvrSystemVoipState

FOvrUserAccountAgeCategory

FOvrUserCapability

FOvrUserCapabilityPages

FOvrUserDataStoreUpdateResponse

FOvrUserOptions

FOvrUserReportID

FOvrVoipDecoder

FOvrVoipEncoder

FOvrVoipOptions

OVRPlatformCppPageRequests.h

OVRPlatformCppRequests.h

OVRPlatformEnums.h

OVRPlatformFunctions.h

OVRPlatformModels.h

OVRPlatformOptions.h

OVRPlatformPageRequests.h

OVRPlatformRequests.h

OVRPlatformRequestsSupport.h

OVRPlatformSubsystem.h

OVRPlatformTypes.h

OVRPlatformUtils.h

OVR_AbuseReportOptions.h

OVR_AbuseReportRecording.h

OVR_AbuseReportType.h

OVR_AbuseReportVideoMode.h

OVR_AccountAgeCategory.h

OVR_AchievementDefinition.h

OVR_AchievementDefinitionArray.h

OVR_AchievementProgress.h

OVR_AchievementProgressArray.h

OVR_AchievementType.h

OVR_AchievementUpdate.h

OVR_AdvancedAbuseReportOptions.h

OVR_AppAgeCategory.h

OVR_AppDownloadProgressResult.h

OVR_AppDownloadResult.h

OVR_AppInstallResult.h

OVR_AppStatus.h

OVR_ApplicationInvite.h

OVR_ApplicationInviteArray.h

OVR_ApplicationOptions.h

OVR_ApplicationVersion.h

OVR_AssetDetails.h

OVR_AssetDetailsArray.h

OVR_AssetFileDeleteResult.h

OVR_AssetFileDownloadCancelResult.h

OVR_AssetFileDownloadResult.h

OVR_AssetFileDownloadUpdate.h

OVR_AvatarEditorOptions.h

OVR_AvatarEditorResult.h

OVR_BlockedUser.h

OVR_BlockedUserArray.h

OVR_Challenge.h

OVR_ChallengeArray.h

OVR_ChallengeCreationType.h

OVR_ChallengeEntry.h

OVR_ChallengeEntryArray.h

OVR_ChallengeOptions.h

OVR_ChallengeViewerFilter.h

OVR_ChallengeVisibility.h

OVR_CowatchViewer.h

OVR_CowatchViewerArray.h

OVR_CowatchViewerUpdate.h

OVR_CowatchingState.h

OVR_DataStore.h

OVR_Destination.h

OVR_DestinationArray.h

OVR_Functions_ApplicationLifecycle.h

OVR_Functions_Voip.h

OVR_GroupPresenceJoinIntent.h

OVR_GroupPresenceLeaveIntent.h

OVR_GroupPresenceOptions.h

OVR_HttpTransferUpdate.h

OVR_InstalledApplication.h

OVR_InstalledApplicationArray.h

OVR_InviteOptions.h

OVR_InvitePanelResultInfo.h

OVR_KeyValuePairType.h

OVR_LanguagePackInfo.h

OVR_LaunchBlockFlowResult.h

OVR_LaunchDetails.h

OVR_LaunchFriendRequestFlowResult.h

OVR_LaunchInvitePanelFlowResult.h

OVR_LaunchReportFlowResult.h

OVR_LaunchResult.h

OVR_LaunchType.h

OVR_LaunchUnblockFlowResult.h

OVR_Leaderboard.h

OVR_LeaderboardArray.h

OVR_LeaderboardEntry.h

OVR_LeaderboardEntryArray.h

OVR_LeaderboardFilterType.h

OVR_LeaderboardStartAt.h

OVR_LeaderboardUpdateStatus.h

OVR_LinkedAccount.h

OVR_LinkedAccountArray.h

OVR_LivestreamingApplicationStatus.h

OVR_LivestreamingAudience.h

OVR_LivestreamingMicrophoneStatus.h

OVR_LivestreamingStartResult.h

OVR_LivestreamingStartStatus.h

OVR_LivestreamingStatus.h

OVR_LivestreamingVideoStats.h

OVR_LogEventName.h

OVR_LogEventParameter.h

OVR_MediaContentType.h

OVR_MessageType.h

OVR_Microphone.h

OVR_MicrophoneAvailabilityState.h

OVR_MultiplayerErrorErrorKey.h

OVR_MultiplayerErrorOptions.h

OVR_NetSyncConnection.h

OVR_NetSyncConnectionStatus.h

OVR_NetSyncDisconnectReason.h

OVR_NetSyncOptions.h

OVR_NetSyncSession.h

OVR_NetSyncSessionArray.h

OVR_NetSyncSessionsChangedNotification.h

OVR_NetSyncSetSessionPropertyResult.h

OVR_NetSyncVoipAttenuationValue.h

OVR_NetSyncVoipAttenuationValueArray.h

OVR_NetSyncVoipMicSource.h

OVR_NetSyncVoipStreamMode.h

OVR_OrgScopedID.h

OVR_PartyMicState.h

OVR_PartyUpdateAction.h

OVR_PartyUpdateNotification.h

OVR_PermissionGrantStatus.h

OVR_PermissionType.h

OVR_PlatformInitialize.h

OVR_PlatformInitializeResult.h

OVR_PlatformVersion.h

OVR_Platform_Defs.h

OVR_Platform_Internal.h

OVR_ProductArray.h

OVR_PurchaseArray.h

OVR_RejoinDialogResult.h

OVR_ReportRequestResponse.h

OVR_Requests_AbuseReport.h

OVR_Requests_Achievements.h

OVR_Requests_Application.h

OVR_Requests_ApplicationLifecycle.h

OVR_Requests_AssetFile.h

OVR_Requests_Avatar.h

OVR_Requests_Challenges.h

OVR_Requests_Cowatching.h

OVR_Requests_DeviceApplicationIntegrity.h

OVR_Requests_Entitlement.h

OVR_Requests_GroupPresence.h

OVR_Requests_IAP.h

OVR_Requests_LanguagePack.h

OVR_Requests_Leaderboard.h

OVR_Requests_Media.h

OVR_Requests_Notification.h

OVR_Requests_Party.h

OVR_Requests_RichPresence.h

OVR_Requests_User.h

OVR_Requests_UserAgeCategory.h

OVR_Requests_Voip.h

OVR_RichPresenceExtraContext.h

OVR_RichPresenceOptions.h

OVR_RosterOptions.h

OVR_SdkAccount.h

OVR_SdkAccountArray.h

OVR_SdkAccountType.h

OVR_SendInvitesResult.h

OVR_ServiceProvider.h

OVR_ShareMediaResult.h

OVR_ShareMediaStatus.h

OVR_SupplementaryMetric.h

OVR_SystemVoipState.h

OVR_SystemVoipStatus.h

OVR_TimeWindow.h

OVR_UserAccountAgeCategory.h

OVR_UserArray.h

OVR_UserCapability.h

OVR_UserCapabilityArray.h

OVR_UserDataStoreUpdateResponse.h

OVR_UserOptions.h

OVR_UserOrdering.h

OVR_UserPresenceStatus.h

OVR_UserProof.h

OVR_UserReportID.h

OVR_VoipBitrate.h

OVR_VoipDecoder.h

OVR_VoipDtxState.h

OVR_VoipEncoder.h

OVR_VoipMuteState.h

OVR_VoipOptions.h

OVR_VoipSampleRate.h

OVR_Voip_LowLevel.h

TOvrMessageHandle

UOvrAchievementDefinitionPagesMethods

UOvrAchievementProgressPagesMethods

UOvrApplicationInvitePagesMethods

UOvrBlockedUserPagesMethods

UOvrChallengeEntryPagesMethods

UOvrChallengePagesMethods

UOvrCowatchViewerPagesMethods

UOvrDestinationPagesMethods

UOvrFunctionsBlueprintLibrary

UOvrLeaderboardEntryPagesMethods

UOvrLeaderboardPagesMethods

UOvrMicrophoneMethods

UOvrPacketMethods

UOvrPageRequestsBlueprintLibrary

UOvrPlatformSubsystem

UOvrPlatformUtilsLibrary

UOvrProductPagesMethods

UOvrPurchasePagesMethods

UOvrRequestsBlueprintLibrary

UOvrUserCapabilityPagesMethods

UOvrUserPagesMethods

ovrKeyValuePair

ovrOculusInitParams

ovrPlatformLogValue

FOvrUser Struct

Overview

Data Fields

FString	DisplayName`[Get]`
FOvrId	ID`[Get]`
FString	ImageUrl`[Get]`
FString	OculusID`[Get]`
FString	Presence`[Get]`
FString	PresenceDeeplinkMessage`[Get]`
FString	PresenceDestinationApiName`[Get]`
FString	PresenceLobbySessionId`[Get]`
FString	PresenceMatchSessionId`[Get]`
EOvrUserPresenceStatus	PresenceStatus`[Get]`
FString	SmallImageUrl`[Get]`

Public Member Functions

	FOvrUser ( )
	FOvrUser ( ovrUserHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr )
void	Clear ( )
void	Update ( ovrUserHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr )

Details

Fields

FString FOvrUser::DisplayName
A potentially non unique displayable name chosen by the user. Could also be the same as the oculus_ID

FOvrId FOvrUser::ID
No description available.

FString FOvrUser::ImageUrl
No description available.

FString FOvrUser::OculusID
No description available.

FString FOvrUser::Presence
Human readable string of what the user is currently doing. Not intended to be parsed as it might change at anytime or be translated

FString FOvrUser::PresenceDeeplinkMessage
Intended to be parsed and used to deeplink to parts of the app

FString FOvrUser::PresenceDestinationApiName
If provided, the destination this user is currently at in the app

FString FOvrUser::PresenceLobbySessionId
If provided, the lobby session this user is currently at in the app

FString FOvrUser::PresenceMatchSessionId
If provided, the match session this user is currently at in the app

EOvrUserPresenceStatus FOvrUser::PresenceStatus
Enum value of what the user is currently doing.

FString FOvrUser::SmallImageUrl
No description available.

Member Functions

FOvrUser::FOvrUser ( )
No description available.

FOvrUser::FOvrUser ( ovrUserHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr )
No description available.

void FOvrUser::Clear ( )
No description available.

void FOvrUser::Update ( ovrUserHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr )
No description available.

Did you find this page helpful?