Meta Developers

The Message class represents a message object that contains information about a specific event or action. It provides a way to access and manipulate the message's contents, including its type, error status, request ID, and message. See details here.

Member Enumerations

Enumeration MessageType

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_GetLoggedInUserManagedInfo	= 0x70BA3AEE
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	The user has tapped the report button in the panel that appears after pressing the Oculus button.
Notification_ApplicationLifecycle_LaunchIntentChanged	This event is triggered when a launch intent is received, whether it's a cold or warm start. The payload contains the type of intent that was received. To obtain additional details, you should call the ApplicationLifecycle.GetLaunchDetails() function.
Notification_AssetFile_DownloadUpdate	Sent to indicate download progress for asset files.
Notification_Cowatching_ApiNotReady	Sets a callback function that will be triggered when the user is no longer in a copresent state and cowatching actions should not be performed.
Notification_Cowatching_ApiReady	Sets a callback function that will be triggered when the user is in a copresent state and cowatching is ready to begin.
Notification_Cowatching_InSessionChanged	Sets a callback function that will be triggered when the current user joins/leaves the cowatching session.
Notification_Cowatching_Initialized	Sets a callback function that will be triggered when the cowatching API has been initialized. At this stage, the API is not yet ready for use.
Notification_Cowatching_PresenterDataChanged	Sets a callback function that will be triggered when the presenter updates the presenter data.
Notification_Cowatching_SessionStarted	Sets a callback function that will be triggered when a user has started a cowatching session, and the ID of the session is reflected in the payload.
Notification_Cowatching_SessionStopped	Sets a callback function that will be triggered when a cowatching session has ended.
Notification_Cowatching_ViewersDataChanged	Sets a callback function that will be triggered when a user joins or updates their viewer data.
Notification_GroupPresence_InvitationsSent	Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees. Parameter: Callback is a function that will be called when the invitation sent status changes. Models.LaunchInvitePanelFlowResult has 1 member: UserList LaunchInvitePanelFlowResult::InvitedUsers - A list of users that were sent an invitation to the session.
Notification_GroupPresence_JoinIntentReceived	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. Parameter: Callback is a function that will be called when a user has chosen to join the destination/lobby/match. Models.GroupPresenceJoinIntent has 4 members: string GroupPresenceJoinIntent::DeeplinkMessage - An opaque string provided by the developer to help them deeplink to content. string GroupPresenceJoinIntent::DestinationApiName - The destination the current user wants to go to. string GroupPresenceJoinIntent::LobbySessionId - The lobby session the current user wants to go to. string GroupPresenceJoinIntent::MatchSessionId - The match session the current user wants to go to.
Notification_GroupPresence_LeaveIntentReceived	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. Parameter: Callback is a function that will be called when the user has chosen to leave the destination/lobby/match. Models.GroupPresenceLeaveIntent has 3 members: string GroupPresenceLeaveIntent::DestinationApiName - The destination the current user wants to leave. string GroupPresenceLeaveIntent::LobbySessionId - The lobby session the current user wants to leave. string GroupPresenceLeaveIntent::MatchSessionId - The match session the current user wants to leave.
Notification_HTTP_Transfer	Sent to indicate that more data has been read or an error occured.
Notification_Livestreaming_StatusChange	Indicates that the livestreaming session has been updated. You can use this information to throttle your game performance or increase CPU/GPU performance. Use Models.LivestreamingStatus to extract the updated livestreaming status.
Notification_NetSync_ConnectionStatusChanged	Sent when the status of a connection has changed. The payload will be a type of Models.NetSyncConnection.
Notification_NetSync_SessionsChanged	Sent when the list of known connected sessions has changed. Contains the new list of sessions. The payload will be a type of Models.NetSyncSessionsChangedNotification.
Notification_Party_PartyUpdate	Indicates that party has been updated. This will return a Models.PartyUpdateNotification object.
Notification_Voip_MicrophoneAvailabilityStateUpdate	Indicates that the current microphone availability state has been updated. Use Voip.GetMicrophoneAvailability() to extract the microphone availability state.
Notification_Voip_SystemVoipState	Sent to indicate that some part of the overall state of SystemVoip has changed. Use SystemVoipState::Status and the properties of Models.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	Gets VR camera related WebRTC data channel messages for update. This method is used to retrieve messages that are sent over the WebRTC data channel, which can include information about the VR camera system, such as its current state or any errors that may have occurred.
Notification_Vrcamera_GetSurfaceUpdate	Gets the surface and update action from the platform WebRTC for update. This method is used to retrieve information about the current state of the VR camera system, including any updates that may be required. See more info about Platform Solutions here.
Platform_InitializeWithAccessToken	= 0x35692F2B
Platform_InitializeStandaloneOculus	= 0x51F8CE0C
Platform_InitializeAndroidAsynchronous	= 0x1AD307B4
Platform_InitializeWindowsAsynchronous	= 0x6DA7BA8F

Properties

T Data[Get]

The data property provides access to the message's contents, allowing you to retrieve and manipulate the data within.

MessageType Type[Get]

Returns the message type, which is defined as Message.MessageType, indicating the purpose or category of the message.

bool IsError[Get]

Indicates whether the message represents an error or not, based on the presence of an error object.

ulong RequestID[Get]

Returns the unique identifier of the request that generated this message, if applicable.

static ExtraMessageTypesHandler HandleExtraMessageTypes

Member Functions

new delegate void Callback

( Message< T > message )

The Callback delegate represents a method that will be called when a message of type T is received. The method takes a single parameter, message, which is an instance of the Message<T> class containing the message data.

Message

( IntPtr c_message )

The Message(IntPtr c_message) constructor takes an IntPtr parameter c_message which represents the native message object. It calls the base constructor Message() to initialize the message object. If the message is not an error message, it retrieves the data from the message using the GetDataFromMessage() method and stores it in the data field.

delegate void Callback

( Message message )

The Callback delegate represents a method that will be called when a Message.MessageType is received. The method takes a single parameter, message, which is an instance of the Message.MessageType class containing the message data.

Message

( IntPtr c_message )

The Message(IntPtr c_message) constructor takes an IntPtr parameter c_message which represents the native message object. It initializes the Message object with the contents of the native message object.

virtual Error GetError ( )

Returns the error object associated with this message, or null if there is no error.

virtual HttpTransferUpdate GetHttpTransferUpdate ( )

Returns an object containing information about the HTTP transfer update, or null if there is no update.

virtual PlatformInitialize GetPlatformInitialize ( )

Returns an object containing information about the platform initialization, or null if there is no initialization.

virtual AbuseReportRecording GetAbuseReportRecording ( )

Returns the value of the AbuseReportRecording property, or false/null depending on the type of the property.

virtual AchievementDefinitionList GetAchievementDefinitions ( )

Returns the value of the AchievementDefinitions property, or false/null depending on the type of the property.

virtual AchievementProgressList GetAchievementProgressList ( )

Returns the value of the AchievementProgressList property, or false/null depending on the type of the property.

virtual AchievementUpdate GetAchievementUpdate ( )

Returns the value of the AchievementUpdate property, or false/null depending on the type of the property.

virtual AppDownloadProgressResult GetAppDownloadProgressResult ( )

Returns the value of the AppDownloadProgressResult property, or false/null depending on the type of the property.

virtual AppDownloadResult GetAppDownloadResult ( )

Returns the value of the AppDownloadResult property, or false/null depending on the type of the property.

virtual ApplicationInviteList GetApplicationInviteList ( )

Returns the value of the ApplicationInviteList property, or false/null depending on the type of the property.

virtual ApplicationVersion GetApplicationVersion ( )

Returns the value of the ApplicationVersion property, or false/null depending on the type of the property.

virtual AssetDetails GetAssetDetails ( )

Returns the value of the AssetDetails property, or false/null depending on the type of the property.

virtual AssetDetailsList GetAssetDetailsList ( )

Returns the value of the AssetDetailsList property, or false/null depending on the type of the property.

virtual AssetFileDeleteResult GetAssetFileDeleteResult ( )

Returns the value of the AssetFileDeleteResult property, or false/null depending on the type of the property.

virtual AssetFileDownloadCancelResult GetAssetFileDownloadCancelResult ( )

Returns the value of the AssetFileDownloadCancelResult property, or false/null depending on the type of the property.

virtual AssetFileDownloadResult GetAssetFileDownloadResult ( )

Returns the value of the AssetFileDownloadResult property, or false/null depending on the type of the property.

virtual AssetFileDownloadUpdate GetAssetFileDownloadUpdate ( )

Returns the value of the AssetFileDownloadUpdate property, or false/null depending on the type of the property.

virtual AvatarEditorResult GetAvatarEditorResult ( )

Returns the value of the AvatarEditorResult property, or false/null depending on the type of the property.

virtual BlockedUserList GetBlockedUserList ( )

Returns the value of the BlockedUserList property, or false/null depending on the type of the property.

virtual Challenge GetChallenge ( )

Returns the value of the Challenge property, or false/null depending on the type of the property.

virtual ChallengeEntryList GetChallengeEntryList ( )

Returns the value of the ChallengeEntryList property, or false/null depending on the type of the property.

virtual ChallengeList GetChallengeList ( )

Returns the value of the ChallengeList property, or false/null depending on the type of the property.

virtual CowatchingState GetCowatchingState ( )

Returns the value of the CowatchingState property, or false/null depending on the type of the property.

virtual CowatchViewerList GetCowatchViewerList ( )

Returns the value of the CowatchViewerList property, or false/null depending on the type of the property.

virtual CowatchViewerUpdate GetCowatchViewerUpdate ( )

Returns the value of the CowatchViewerUpdate property, or false/null depending on the type of the property.

virtual DestinationList GetDestinationList ( )

Returns the value of the DestinationList property, or false/null depending on the type of the property.

virtual GroupPresenceJoinIntent GetGroupPresenceJoinIntent ( )

Returns the value of the GroupPresenceJoinIntent property, or false/null depending on the type of the property.

virtual GroupPresenceLeaveIntent GetGroupPresenceLeaveIntent ( )

Returns the value of the GroupPresenceLeaveIntent property, or false/null depending on the type of the property.

virtual InstalledApplicationList GetInstalledApplicationList ( )

Returns the value of the InstalledApplicationList property, or false/null depending on the type of the property.

virtual InvitePanelResultInfo GetInvitePanelResultInfo ( )

Returns the value of the InvitePanelResultInfo property, or false/null depending on the type of the property.

virtual LaunchBlockFlowResult GetLaunchBlockFlowResult ( )

Returns the value of the LaunchBlockFlowResult property, or false/null depending on the type of the property.

virtual LaunchFriendRequestFlowResult GetLaunchFriendRequestFlowResult ( )

Returns the value of the LaunchFriendRequestFlowResult property, or false/null depending on the type of the property.

virtual LaunchInvitePanelFlowResult GetLaunchInvitePanelFlowResult ( )

Returns the value of the LaunchInvitePanelFlowResult property, or false/null depending on the type of the property.

virtual LaunchReportFlowResult GetLaunchReportFlowResult ( )

Returns the value of the LaunchReportFlowResult property, or false/null depending on the type of the property.

virtual LaunchUnblockFlowResult GetLaunchUnblockFlowResult ( )

Returns the value of the LaunchUnblockFlowResult property, or false/null depending on the type of the property.

virtual bool GetLeaderboardDidUpdate ( )

Returns the value of the LeaderboardDidUpdate property, or false/null depending on the type of the property.

virtual LeaderboardEntryList GetLeaderboardEntryList ( )

Returns the value of the LeaderboardEntryList property, or false/null depending on the type of the property.

virtual LeaderboardList GetLeaderboardList ( )

Returns the value of the LeaderboardList property, or false/null depending on the type of the property.

virtual LinkedAccountList GetLinkedAccountList ( )

Returns the value of the LinkedAccountList property, or false/null depending on the type of the property.

virtual LivestreamingApplicationStatus GetLivestreamingApplicationStatus ( )

Returns the value of the LivestreamingApplicationStatus property, or false/null depending on the type of the property.

virtual LivestreamingStartResult GetLivestreamingStartResult ( )

Returns the value of the LivestreamingStartResult property, or false/null depending on the type of the property.

virtual LivestreamingStatus GetLivestreamingStatus ( )

Returns the value of the LivestreamingStatus property, or false/null depending on the type of the property.

virtual LivestreamingVideoStats GetLivestreamingVideoStats ( )

Returns the value of the LivestreamingVideoStats property, or false/null depending on the type of the property.

virtual MicrophoneAvailabilityState GetMicrophoneAvailabilityState ( )

Returns the value of the MicrophoneAvailabilityState property, or false/null depending on the type of the property.

virtual NetSyncConnection GetNetSyncConnection ( )

Returns the value of the NetSyncConnection property, or false/null depending on the type of the property.

virtual NetSyncSessionList GetNetSyncSessionList ( )

Returns the value of the NetSyncSessionList property, or false/null depending on the type of the property.

virtual NetSyncSessionsChangedNotification GetNetSyncSessionsChangedNotification ( )

Returns the value of the NetSyncSessionsChangedNotification property, or false/null depending on the type of the property.

virtual NetSyncSetSessionPropertyResult GetNetSyncSetSessionPropertyResult ( )

Returns the value of the NetSyncSetSessionPropertyResult property, or false/null depending on the type of the property.

virtual NetSyncVoipAttenuationValueList GetNetSyncVoipAttenuationValueList ( )

Returns the value of the NetSyncVoipAttenuationValueList property, or false/null depending on the type of the property.

virtual OrgScopedID GetOrgScopedID ( )

Returns the value of the OrgScopedID property, or false/null depending on the type of the property.

virtual Party GetParty ( )

Returns the value of the Party property, or false/null depending on the type of the property.

virtual PartyID GetPartyID ( )

Returns the value of the PartyID property, or false/null depending on the type of the property.

virtual PartyUpdateNotification GetPartyUpdateNotification ( )

Returns the value of the PartyUpdateNotification property, or false/null depending on the type of the property.

virtual PidList GetPidList ( )

Returns the value of the PidList property, or false/null depending on the type of the property.

virtual ProductList GetProductList ( )

Returns the value of the ProductList property, or false/null depending on the type of the property.

virtual Purchase GetPurchase ( )

Returns the value of the Purchase property, or false/null depending on the type of the property.

virtual PurchaseList GetPurchaseList ( )

Returns the value of the PurchaseList property, or false/null depending on the type of the property.

virtual RejoinDialogResult GetRejoinDialogResult ( )

Returns the value of the RejoinDialogResult property, or false/null depending on the type of the property.

virtual SdkAccountList GetSdkAccountList ( )

Returns the value of the SdkAccountList property, or false/null depending on the type of the property.

virtual SendInvitesResult GetSendInvitesResult ( )

Returns the value of the SendInvitesResult property, or false/null depending on the type of the property.

virtual ShareMediaResult GetShareMediaResult ( )

Returns the value of the ShareMediaResult property, or false/null depending on the type of the property.

virtual string GetString ( )

Returns the value of the String property, or false/null depending on the type of the property.

virtual SystemVoipState GetSystemVoipState ( )

Returns the value of the SystemVoipState property, or false/null depending on the type of the property.

virtual User GetUser ( )

Returns the value of the User property, or false/null depending on the type of the property.

virtual UserAccountAgeCategory GetUserAccountAgeCategory ( )

Returns the value of the UserAccountAgeCategory property, or false/null depending on the type of the property.

virtual UserCapabilityList GetUserCapabilityList ( )

Returns the value of the UserCapabilityList property, or false/null depending on the type of the property.

virtual UserList GetUserList ( )

Returns the value of the UserList property, or false/null depending on the type of the property.

virtual UserProof GetUserProof ( )

Returns the value of the UserProof property, or false/null depending on the type of the property.

virtual UserReportID GetUserReportID ( )

Returns the value of the UserReportID property, or false/null depending on the type of the property.

Protected Functions

abstract T GetDataFromMessage

( IntPtr c_message )

Object Data for package-static-func

static Message ParseMessageHandle

( IntPtr messageHandle )

Static Member Functions

static Message PopMessage ( )

Object Data for package-func

delegate Message ExtraMessageTypesHandler

( IntPtr messageHandle,

Message.MessageType message_type )

Did you find this page helpful?