API reference

Message Class

Extends Message

Constructors

Message ( c_message )
Signature
Oculus.Platform.Message< T >.Message(IntPtr c_message)
Parameters
c_message: IntPtr
Message ( c_message )
Signature
Oculus.Platform.Message< T >.Message(IntPtr c_message)
Parameters
c_message: IntPtr

Properties

Data : T
[Get]
Signature
T Oculus.Platform.Message< T >.Data
HandleExtraMessageTypes : ExtraMessageTypesHandler
[Set]
Signature
ExtraMessageTypesHandler Oculus.Platform.Message< T >.HandleExtraMessageTypes
IsError : bool
[Get]
Signature
bool Oculus.Platform.Message< T >.IsError
RequestID : ulong
[Get]
Signature
ulong Oculus.Platform.Message< T >.RequestID
[Get]
Signature
MessageType Oculus.Platform.Message< T >.Type

Protected Methods

GetDataFromMessage ( c_message )
Signature
abstract T Oculus.Platform.Message< T >.GetDataFromMessage(IntPtr c_message)
Parameters
c_message: IntPtr
Returns
abstract T

Methods

Callback ( message )
Signature
new delegate void Oculus.Platform.Message< T >.Callback(Message< T > message)
Parameters
message: Message< T >
Returns
new delegate void
Callback ( message )
Signature
delegate void Oculus.Platform.Message< T >.Callback(Message message)
Parameters
message: Message
Returns
delegate void
GetAbuseReportRecording ()
Signature
virtual AbuseReportRecording Oculus.Platform.Message< T >.GetAbuseReportRecording()
Returns
AbuseReportRecording
GetAchievementDefinitions ()
Signature
virtual AchievementDefinitionList Oculus.Platform.Message< T >.GetAchievementDefinitions()
Returns
AchievementDefinitionList
GetAchievementProgressList ()
Signature
virtual AchievementProgressList Oculus.Platform.Message< T >.GetAchievementProgressList()
Returns
AchievementProgressList
GetAchievementUpdate ()
Signature
virtual AchievementUpdate Oculus.Platform.Message< T >.GetAchievementUpdate()
Returns
AchievementUpdate
GetAppDownloadProgressResult ()
Signature
virtual AppDownloadProgressResult Oculus.Platform.Message< T >.GetAppDownloadProgressResult()
Returns
AppDownloadProgressResult
GetAppDownloadResult ()
Signature
virtual AppDownloadResult Oculus.Platform.Message< T >.GetAppDownloadResult()
Returns
AppDownloadResult
GetApplicationInviteList ()
Signature
virtual ApplicationInviteList Oculus.Platform.Message< T >.GetApplicationInviteList()
Returns
ApplicationInviteList
GetApplicationVersion ()
Signature
virtual ApplicationVersion Oculus.Platform.Message< T >.GetApplicationVersion()
Returns
ApplicationVersion
GetAssetDetails ()
Signature
virtual AssetDetails Oculus.Platform.Message< T >.GetAssetDetails()
Returns
AssetDetails
GetAssetDetailsList ()
Signature
virtual AssetDetailsList Oculus.Platform.Message< T >.GetAssetDetailsList()
Returns
AssetDetailsList
GetAssetFileDeleteResult ()
Signature
virtual AssetFileDeleteResult Oculus.Platform.Message< T >.GetAssetFileDeleteResult()
Returns
AssetFileDeleteResult
GetAssetFileDownloadCancelResult ()
Signature
virtual AssetFileDownloadCancelResult Oculus.Platform.Message< T >.GetAssetFileDownloadCancelResult()
Returns
AssetFileDownloadCancelResult
GetAssetFileDownloadResult ()
Signature
virtual AssetFileDownloadResult Oculus.Platform.Message< T >.GetAssetFileDownloadResult()
Returns
AssetFileDownloadResult
GetAssetFileDownloadUpdate ()
Signature
virtual AssetFileDownloadUpdate Oculus.Platform.Message< T >.GetAssetFileDownloadUpdate()
Returns
AssetFileDownloadUpdate
GetAvatarEditorResult ()
Signature
virtual AvatarEditorResult Oculus.Platform.Message< T >.GetAvatarEditorResult()
Returns
AvatarEditorResult
GetBlockedUserList ()
Signature
virtual BlockedUserList Oculus.Platform.Message< T >.GetBlockedUserList()
Returns
BlockedUserList
GetChallenge ()
Signature
virtual Challenge Oculus.Platform.Message< T >.GetChallenge()
Returns
Challenge
GetChallengeEntryList ()
Signature
virtual ChallengeEntryList Oculus.Platform.Message< T >.GetChallengeEntryList()
Returns
ChallengeEntryList
GetChallengeList ()
Signature
virtual ChallengeList Oculus.Platform.Message< T >.GetChallengeList()
Returns
ChallengeList
GetCowatchingState ()
Signature
virtual CowatchingState Oculus.Platform.Message< T >.GetCowatchingState()
Returns
CowatchingState
GetCowatchViewerList ()
Signature
virtual CowatchViewerList Oculus.Platform.Message< T >.GetCowatchViewerList()
Returns
CowatchViewerList
GetCowatchViewerUpdate ()
Signature
virtual CowatchViewerUpdate Oculus.Platform.Message< T >.GetCowatchViewerUpdate()
Returns
CowatchViewerUpdate
GetDestinationList ()
Signature
virtual DestinationList Oculus.Platform.Message< T >.GetDestinationList()
Returns
DestinationList
GetError ()
Signature
virtual Error Oculus.Platform.Message< T >.GetError()
Returns
Error
GetGroupPresenceJoinIntent ()
Signature
virtual GroupPresenceJoinIntent Oculus.Platform.Message< T >.GetGroupPresenceJoinIntent()
Returns
GroupPresenceJoinIntent
GetGroupPresenceLeaveIntent ()
Signature
virtual GroupPresenceLeaveIntent Oculus.Platform.Message< T >.GetGroupPresenceLeaveIntent()
Returns
GroupPresenceLeaveIntent
GetHttpTransferUpdate ()
Signature
virtual HttpTransferUpdate Oculus.Platform.Message< T >.GetHttpTransferUpdate()
Returns
HttpTransferUpdate
GetInstalledApplicationList ()
Signature
virtual InstalledApplicationList Oculus.Platform.Message< T >.GetInstalledApplicationList()
Returns
InstalledApplicationList
GetInvitePanelResultInfo ()
Signature
virtual InvitePanelResultInfo Oculus.Platform.Message< T >.GetInvitePanelResultInfo()
Returns
InvitePanelResultInfo
GetLaunchBlockFlowResult ()
Signature
virtual LaunchBlockFlowResult Oculus.Platform.Message< T >.GetLaunchBlockFlowResult()
Returns
LaunchBlockFlowResult
GetLaunchFriendRequestFlowResult ()
Signature
virtual LaunchFriendRequestFlowResult Oculus.Platform.Message< T >.GetLaunchFriendRequestFlowResult()
Returns
LaunchFriendRequestFlowResult
GetLaunchInvitePanelFlowResult ()
Signature
virtual LaunchInvitePanelFlowResult Oculus.Platform.Message< T >.GetLaunchInvitePanelFlowResult()
Returns
LaunchInvitePanelFlowResult
GetLaunchReportFlowResult ()
Signature
virtual LaunchReportFlowResult Oculus.Platform.Message< T >.GetLaunchReportFlowResult()
Returns
LaunchReportFlowResult
GetLaunchUnblockFlowResult ()
Signature
virtual LaunchUnblockFlowResult Oculus.Platform.Message< T >.GetLaunchUnblockFlowResult()
Returns
LaunchUnblockFlowResult
GetLeaderboardDidUpdate ()
Signature
virtual bool Oculus.Platform.Message< T >.GetLeaderboardDidUpdate()
Returns
bool
GetLeaderboardEntryList ()
Signature
virtual LeaderboardEntryList Oculus.Platform.Message< T >.GetLeaderboardEntryList()
Returns
LeaderboardEntryList
GetLeaderboardList ()
Signature
virtual LeaderboardList Oculus.Platform.Message< T >.GetLeaderboardList()
Returns
LeaderboardList
GetLinkedAccountList ()
Signature
virtual LinkedAccountList Oculus.Platform.Message< T >.GetLinkedAccountList()
Returns
LinkedAccountList
GetLivestreamingApplicationStatus ()
Signature
virtual LivestreamingApplicationStatus Oculus.Platform.Message< T >.GetLivestreamingApplicationStatus()
Returns
LivestreamingApplicationStatus
GetLivestreamingStartResult ()
Signature
virtual LivestreamingStartResult Oculus.Platform.Message< T >.GetLivestreamingStartResult()
Returns
LivestreamingStartResult
GetLivestreamingStatus ()
Signature
virtual LivestreamingStatus Oculus.Platform.Message< T >.GetLivestreamingStatus()
Returns
LivestreamingStatus
GetLivestreamingVideoStats ()
Signature
virtual LivestreamingVideoStats Oculus.Platform.Message< T >.GetLivestreamingVideoStats()
Returns
LivestreamingVideoStats
GetMicrophoneAvailabilityState ()
Signature
virtual MicrophoneAvailabilityState Oculus.Platform.Message< T >.GetMicrophoneAvailabilityState()
Returns
MicrophoneAvailabilityState
GetNetSyncConnection ()
Signature
virtual NetSyncConnection Oculus.Platform.Message< T >.GetNetSyncConnection()
Returns
NetSyncConnection
GetNetSyncSessionList ()
Signature
virtual NetSyncSessionList Oculus.Platform.Message< T >.GetNetSyncSessionList()
Returns
NetSyncSessionList
GetNetSyncSessionsChangedNotification ()
Signature
virtual NetSyncSessionsChangedNotification Oculus.Platform.Message< T >.GetNetSyncSessionsChangedNotification()
Returns
NetSyncSessionsChangedNotification
GetNetSyncSetSessionPropertyResult ()
Signature
virtual NetSyncSetSessionPropertyResult Oculus.Platform.Message< T >.GetNetSyncSetSessionPropertyResult()
Returns
NetSyncSetSessionPropertyResult
GetNetSyncVoipAttenuationValueList ()
Signature
virtual NetSyncVoipAttenuationValueList Oculus.Platform.Message< T >.GetNetSyncVoipAttenuationValueList()
Returns
NetSyncVoipAttenuationValueList
GetOrgScopedID ()
Signature
virtual OrgScopedID Oculus.Platform.Message< T >.GetOrgScopedID()
Returns
OrgScopedID
GetParty ()
Signature
virtual Party Oculus.Platform.Message< T >.GetParty()
Returns
Party
GetPartyID ()
Signature
virtual PartyID Oculus.Platform.Message< T >.GetPartyID()
Returns
PartyID
GetPartyUpdateNotification ()
Signature
virtual PartyUpdateNotification Oculus.Platform.Message< T >.GetPartyUpdateNotification()
Returns
PartyUpdateNotification
GetPidList ()
Signature
virtual PidList Oculus.Platform.Message< T >.GetPidList()
Returns
PidList
GetPlatformInitialize ()
Signature
virtual PlatformInitialize Oculus.Platform.Message< T >.GetPlatformInitialize()
Returns
PlatformInitialize
GetProductList ()
Signature
virtual ProductList Oculus.Platform.Message< T >.GetProductList()
Returns
ProductList
GetPurchase ()
Signature
virtual Purchase Oculus.Platform.Message< T >.GetPurchase()
Returns
Purchase
GetPurchaseList ()
Signature
virtual PurchaseList Oculus.Platform.Message< T >.GetPurchaseList()
Returns
PurchaseList
GetRejoinDialogResult ()
Signature
virtual RejoinDialogResult Oculus.Platform.Message< T >.GetRejoinDialogResult()
Returns
RejoinDialogResult
GetSdkAccountList ()
Signature
virtual SdkAccountList Oculus.Platform.Message< T >.GetSdkAccountList()
Returns
SdkAccountList
GetSendInvitesResult ()
Signature
virtual SendInvitesResult Oculus.Platform.Message< T >.GetSendInvitesResult()
Returns
SendInvitesResult
GetShareMediaResult ()
Signature
virtual ShareMediaResult Oculus.Platform.Message< T >.GetShareMediaResult()
Returns
ShareMediaResult
GetString ()
Signature
virtual string Oculus.Platform.Message< T >.GetString()
Returns
string
GetSystemVoipState ()
Signature
virtual SystemVoipState Oculus.Platform.Message< T >.GetSystemVoipState()
Returns
SystemVoipState
GetUser ()
Signature
virtual User Oculus.Platform.Message< T >.GetUser()
Returns
User
GetUserAccountAgeCategory ()
Signature
virtual UserAccountAgeCategory Oculus.Platform.Message< T >.GetUserAccountAgeCategory()
Returns
UserAccountAgeCategory
GetUserCapabilityList ()
Signature
virtual UserCapabilityList Oculus.Platform.Message< T >.GetUserCapabilityList()
Returns
UserCapabilityList
GetUserList ()
Signature
virtual UserList Oculus.Platform.Message< T >.GetUserList()
Returns
UserList
GetUserProof ()
Signature
virtual UserProof Oculus.Platform.Message< T >.GetUserProof()
Returns
UserProof
GetUserReportID ()
Signature
virtual UserReportID Oculus.Platform.Message< T >.GetUserReportID()
Returns
UserReportID

Static Methods

PopMessage ()
Signature
static Message Oculus.Platform.Message< T >.PopMessage()
Returns
Message

Internal Methods

ExtraMessageTypesHandler ( messageHandle , message_type )
Signature
delegate Message Oculus.Platform.Message< T >.ExtraMessageTypesHandler(IntPtr messageHandle, Message.MessageType message_type)
Parameters
messageHandle: IntPtr
message_type: Message.MessageType
Returns
delegate Message

Internal Static Methods

ParseMessageHandle ( messageHandle )
Signature
static Message Oculus.Platform.Message< T >.ParseMessageHandle(IntPtr messageHandle)
Parameters
messageHandle: IntPtr
Returns
Message

Inner Enum

MessageType Enum

Enumeration Constants

MemberValueDescription
Unknown
AbuseReport_ReportRequestHandled
0x4B8EFC86
Achievements_AddCount
0x03E76231
Achievements_AddFields
0x14AA2129
Achievements_GetAllDefinitions
0x03D3458D
Achievements_GetAllProgress
0x4F9FDE1D
Achievements_GetDefinitionsByName
0x629101BC
Achievements_GetNextAchievementDefinitionArrayPage
0x2A7DD255
Achievements_GetNextAchievementProgressArrayPage
0x2F42E727
Achievements_GetProgressByName
0x152663B1
Achievements_Unlock
0x593CCBDD
ApplicationLifecycle_GetRegisteredPIDs
0x04E5CF62
ApplicationLifecycle_GetSessionKey
0x3AAF591D
ApplicationLifecycle_RegisterSessionKey
0x4DB6AFF8
Application_CancelAppDownload
0x7C2060DE
Application_CheckAppDownloadProgress
0x5534A924
Application_GetVersion
0x68670A0E
Application_InstallAppUpdateAndRelaunch
0x14806B85
Application_LaunchOtherApp
0x54E2D1F8
Application_StartAppDownload
0x44FC006E
AssetFile_Delete
0x6D5D7886
AssetFile_DeleteById
0x5AE8CD52
AssetFile_DeleteByName
0x420AC1CF
AssetFile_Download
0x11449FC5
AssetFile_DownloadById
0x2D008992
AssetFile_DownloadByName
0x6336CEFA
AssetFile_DownloadCancel
0x080AD3C7
AssetFile_DownloadCancelById
0x51659514
AssetFile_DownloadCancelByName
0x446AECFA
AssetFile_GetList
0x4AFC6F74
AssetFile_Status
0x02D32F60
AssetFile_StatusById
0x5D955D38
AssetFile_StatusByName
0x41CFDA50
Avatar_LaunchAvatarEditor
0x05F1E153
Challenges_Create
0x6859D641
Challenges_DeclineInvite
0x568E76C0
Challenges_Delete
0x264885CA
Challenges_Get
0x77584EF3
Challenges_GetEntries
0x121AB45F
Challenges_GetEntriesAfterRank
0x08891A7F
Challenges_GetEntriesByIds
0x316509DC
Challenges_GetList
0x43264356
Challenges_GetNextChallenges
0x5B7CA1B6
Challenges_GetNextEntries
0x7F4CA0C6
Challenges_GetPreviousChallenges
0x0EB4040D
Challenges_GetPreviousEntries
0x78C90470
Challenges_Join
0x21248069
Challenges_Leave
0x296116E5
Challenges_UpdateInfo
0x1175BE60
Cowatching_GetNextCowatchViewerArrayPage
0x1D403932
Cowatching_GetPresenterData
0x49864735
Cowatching_GetViewersData
0x5CD7A24F
Cowatching_IsInSession
0x651B4884
Cowatching_JoinSession
0x6388A554
Cowatching_LaunchInviteDialog
0x22933297
Cowatching_LeaveSession
0x3C9E46CD
Cowatching_RequestToPresent
0x7F79BCAA
Cowatching_ResignFromPresenting
0x4B49C202
Cowatching_SetPresenterData
0x6D1C8906
Cowatching_SetViewerData
0x3CDBE826
DeviceApplicationIntegrity_GetIntegrityToken
0x3271ABDA
Entitlement_GetIsViewerEntitled
0x186B58B1
GroupPresence_Clear
0x6DAA9CC3
GroupPresence_GetInvitableUsers
0x234BC3F1
GroupPresence_GetNextApplicationInviteArrayPage
0x04F8C0F2
GroupPresence_GetSentInvites
0x08260AB1
GroupPresence_LaunchInvitePanel
0x0F9ECF9F
GroupPresence_LaunchMultiplayerErrorDialog
0x2955AF24
GroupPresence_LaunchRejoinDialog
0x1577036F
GroupPresence_LaunchRosterPanel
0x35728882
GroupPresence_SendInvites
0x0DCBD364
GroupPresence_Set
0x675F5C24
GroupPresence_SetDeeplinkMessageOverride
0x521ADF0D
GroupPresence_SetDestination
0x4C5B268A
GroupPresence_SetIsJoinable
0x2A8F1055
GroupPresence_SetLobbySession
0x48FF55BE
GroupPresence_SetMatchSession
0x314C84B8
IAP_ConsumePurchase
0x1FBB72D9
IAP_GetNextProductArrayPage
0x1BD94AAF
IAP_GetNextPurchaseArrayPage
0x47570A95
IAP_GetProductsBySKU
0x7E9ACAF5
IAP_GetViewerPurchases
0x3A0F8419
IAP_GetViewerPurchasesDurableCache
0x63599E2B
IAP_LaunchCheckoutFlow
0x3F9B0D0D
LanguagePack_GetCurrent
0x1F90F0D5
LanguagePack_SetCurrent
0x5B4FBBE0
Leaderboard_Get
0x6AD44EF8
Leaderboard_GetEntries
0x5DB3474C
Leaderboard_GetEntriesAfterRank
0x18378BEF
Leaderboard_GetEntriesByIds
0x39607BFC
Leaderboard_GetNextEntries
0x4E207CD9
Leaderboard_GetNextLeaderboardArrayPage
0x35F6769B
Leaderboard_GetPreviousEntries
0x4901DAC0
Leaderboard_WriteEntry
0x117FC8FE
Leaderboard_WriteEntryWithSupplementaryMetric
0x72C692FA
Media_ShareToFacebook
0x00E38AEF
Notification_MarkAsRead
0x717259E3
Party_GetCurrent
0x47933760
RichPresence_Clear
0x57B752B3
RichPresence_GetDestinations
0x586F2D14
RichPresence_GetNextDestinationArrayPage
0x67367F45
RichPresence_Set
0x3C147509
UserAgeCategory_Get
0x21CBE0C0
UserAgeCategory_Report
0x2E4DD8D6
User_Get
0x6BCF9E47
User_GetAccessToken
0x06A85ABE
User_GetBlockedUsers
0x7D201556
User_GetLoggedInUser
0x436F345D
User_GetLoggedInUserFriends
0x587C2A8D
User_GetNextBlockedUserArrayPage
0x7C2AFDCB
User_GetNextUserArrayPage
0x267CF743
User_GetNextUserCapabilityArrayPage
0x2309F399
User_GetOrgScopedID
0x18F0B01B
User_GetSdkAccounts
0x67526A83
User_GetUserProof
0x22810483
User_LaunchBlockFlow
0x6FD62528
User_LaunchFriendRequestFlow
0x0904B598
User_LaunchUnblockFlow
0x14A22A97
Voip_GetMicrophoneAvailability
0x744CE345
Voip_SetSystemVoipSuppressed
0x453FC9AA
Notification_AbuseReport_ReportButtonPressed
0x24472F6C
The user has tapped the report button in the panel that appears after pressing the Oculus button.
Notification_ApplicationLifecycle_LaunchIntentChanged
0x04B34CA3
Sent when a launch intent is received (for both cold and warm starts). The payload is the type of the intent. ApplicationLifecycle.GetLaunchDetails() should be called to get the other details.
Notification_AssetFile_DownloadUpdate
0x2FDD0CCD
Sent to indicate download progress for asset files.
Notification_Cowatching_ApiNotReady
0x66093981
Sent when user is no longer copresent. Cowatching actions should not be performed.
Notification_Cowatching_ApiReady
0x09956693
Sent when user is in copresent and cowatching is ready to go.
Notification_Cowatching_InSessionChanged
0x0DF93113
Sent when the current user joins/leaves the cowatching session.
Notification_Cowatching_Initialized
0x74D948F3
Sent when cowatching api has been initialized. The api is not yet ready at this stage.
Notification_Cowatching_PresenterDataChanged
0x4E078EEE
Sent when the presenter updates the presenter data.
Notification_Cowatching_SessionStarted
0x7321939C
Sent when a user has started a cowatching session whose id is reflected in the payload.
Notification_Cowatching_SessionStopped
0x49E6DBFA
Sent when a cowatching session has ended.
Notification_Cowatching_ViewersDataChanged
0x68F2F1FF
Sent when a user joins or updates their viewer data.
Notification_GroupPresence_InvitationsSent
0x679A84B6
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees.
Notification_GroupPresence_JoinIntentReceived
0x773889F6
Sent when a user has chosen to join the destination/lobby/match. Read all the fields to figure out where the user wants to go and take the appropriate actions to bring them there. If the user is unable to go there, provide adequate messaging to the user on why they cannot go there. These notifications should be responded to immediately.
Notification_GroupPresence_LeaveIntentReceived
0x4737EA1D
Sent when the user has chosen to leave the destination/lobby/match from the Oculus menu. Read the specific fields to check the user is currently from the destination/lobby/match and take the appropriate actions to remove them. Update the user's presence clearing the appropriate fields to indicate the user has left.
Notification_HTTP_Transfer
0x7DD46E2F
Sent to indicate that more data has been read or an error occured.
Notification_Livestreaming_StatusChange
0x2247596E
Indicates that the livestreaming session has been updated. You can use this information to throttle your game performance or increase CPU/GPU performance. Use Message.GetLivestreamingStatus() to extract the updated livestreaming status.
Notification_NetSync_ConnectionStatusChanged
0x073484CA
Sent when the status of a connection has changed.
Notification_NetSync_SessionsChanged
0x387E7F36
Sent when the list of known connected sessions has changed. Contains the new list of sessions.
Notification_Party_PartyUpdate
0x1D118AB2
Indicates that party has been updated.
Notification_Voip_MicrophoneAvailabilityStateUpdate
0x3E20CB57
Indicates that the current microphone availability state has been updated. Use Voip.GetMicrophoneAvailability() to extract the microphone availability state.
Notification_Voip_SystemVoipState
0x58D254A5
Sent to indicate that some part of the overall state of SystemVoip has changed. Use Message.GetSystemVoipState() and the properties of SystemVoipState to extract the state that triggered the notification. Note that the state may have changed further since the notification was generated, and that you may call the GetSystemVoip...() family of functions at any time to get the current state directly.
Notification_Vrcamera_GetDataChannelMessageUpdate
0x6EE4F33C
Get vr camera related webrtc data channel messages for update.
Notification_Vrcamera_GetSurfaceUpdate
0x37F21084
Get surface and update action from platform webrtc for update.
Platform_InitializeWithAccessToken
0x35692F2B
Platform_InitializeStandaloneOculus
0x51F8CE0C
Platform_InitializeAndroidAsynchronous
0x1AD307B4
Platform_InitializeWindowsAsynchronous
0x6DA7BA8F