MetaPlatformSDK_Message
Inherits: RefCounted
A message sent to the current app from the Meta Platform SDK.
Description
A message sent to the current app from the Meta Platform SDK.
Messages can be received from asynchronous requests via the MetaPlatformSDK_Request.completed signal, or from notifications via the MetaPlatformSDK.notification_received signal.
Each message contains a single payload depending on the type. Regardless of the type, the data property will contain the payload. However, if you want to write fully type-safe code, you can instead call the method dedicated to the type of the payload.
Before attempting to access the payload, call is_error or is_success to determine if the message was successful or not. When unsuccessful, check error to get the full error details.
Properties
Variant |
|
|
int |
|
|
|
Methods
Property Descriptions
Variant data = null
Variant get_data ( )
Contains the payload of this message.
MetaPlatformSDK_Error error
MetaPlatformSDK_Error get_error ( )
Contains a MetaPlatformSDK_Error if is_error returns true; otherwise, it's null.
int request_id = 0
int get_request_id ( )
The unique request ID for this message.
MessageType type = 0
MessageType get_type ( )
The message type.
Method Descriptions
MetaPlatformSDK_AbuseReportRecording get_abuse_report_recording ( ) const
Returns a MetaPlatformSDK_AbuseReportRecording if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AchievementDefinitionArray get_achievement_definition_array ( ) const
Returns a MetaPlatformSDK_AchievementDefinitionArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AchievementProgressArray get_achievement_progress_array ( ) const
Returns a MetaPlatformSDK_AchievementProgressArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AchievementUpdate get_achievement_update ( ) const
Returns a MetaPlatformSDK_AchievementUpdate if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AppDownloadProgressResult get_app_download_progress_result ( ) const
Returns a MetaPlatformSDK_AppDownloadProgressResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AppDownloadResult get_app_download_result ( ) const
Returns a MetaPlatformSDK_AppDownloadResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_ApplicationInviteArray get_application_invite_array ( ) const
Returns a MetaPlatformSDK_ApplicationInviteArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_ApplicationVersion get_application_version ( ) const
Returns a MetaPlatformSDK_ApplicationVersion if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AssetDetails get_asset_details ( ) const
Returns a MetaPlatformSDK_AssetDetails if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AssetDetailsArray get_asset_details_array ( ) const
Returns a MetaPlatformSDK_AssetDetailsArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AssetFileDeleteResult get_asset_file_delete_result ( ) const
Returns a MetaPlatformSDK_AssetFileDeleteResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AssetFileDownloadCancelResult get_asset_file_download_cancel_result ( ) const
Returns a MetaPlatformSDK_AssetFileDownloadCancelResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AssetFileDownloadResult get_asset_file_download_result ( ) const
Returns a MetaPlatformSDK_AssetFileDownloadResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AssetFileDownloadUpdate get_asset_file_download_update ( ) const
Returns a MetaPlatformSDK_AssetFileDownloadUpdate if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_AvatarEditorResult get_avatar_editor_result ( ) const
Returns a MetaPlatformSDK_AvatarEditorResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_BlockedUserArray get_blocked_user_array ( ) const
Returns a MetaPlatformSDK_BlockedUserArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_Challenge get_challenge ( ) const
Returns a MetaPlatformSDK_Challenge if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_ChallengeArray get_challenge_array ( ) const
Returns a MetaPlatformSDK_ChallengeArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_ChallengeEntryArray get_challenge_entry_array ( ) const
Returns a MetaPlatformSDK_ChallengeEntryArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_CowatchViewerArray get_cowatch_viewer_array ( ) const
Returns a MetaPlatformSDK_CowatchViewerArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_CowatchViewerUpdate get_cowatch_viewer_update ( ) const
Returns a MetaPlatformSDK_CowatchViewerUpdate if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_CowatchingState get_cowatching_state ( ) const
Returns a MetaPlatformSDK_CowatchingState if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_DataStore get_data_store ( ) const
Returns a MetaPlatformSDK_DataStore if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_DestinationArray get_destination_array ( ) const
Returns a MetaPlatformSDK_DestinationArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_GroupPresenceJoinIntent get_group_presence_join_intent ( ) const
Returns a MetaPlatformSDK_GroupPresenceJoinIntent if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_GroupPresenceLeaveIntent get_group_presence_leave_intent ( ) const
Returns a MetaPlatformSDK_GroupPresenceLeaveIntent if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_HttpTransferUpdate get_http_transfer_update ( ) const
Returns a MetaPlatformSDK_HttpTransferUpdate if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_InstalledApplicationArray get_installed_application_array ( ) const
Returns a MetaPlatformSDK_InstalledApplicationArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_InvitePanelResultInfo get_invite_panel_result_info ( ) const
Returns a MetaPlatformSDK_InvitePanelResultInfo if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LaunchBlockFlowResult get_launch_block_flow_result ( ) const
Returns a MetaPlatformSDK_LaunchBlockFlowResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LaunchFriendRequestFlowResult get_launch_friend_request_flow_result ( ) const
Returns a MetaPlatformSDK_LaunchFriendRequestFlowResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LaunchInvitePanelFlowResult get_launch_invite_panel_flow_result ( ) const
Returns a MetaPlatformSDK_LaunchInvitePanelFlowResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LaunchReportFlowResult get_launch_report_flow_result ( ) const
Returns a MetaPlatformSDK_LaunchReportFlowResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LaunchUnblockFlowResult get_launch_unblock_flow_result ( ) const
Returns a MetaPlatformSDK_LaunchUnblockFlowResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LeaderboardArray get_leaderboard_array ( ) const
Returns a MetaPlatformSDK_LeaderboardArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LeaderboardEntryArray get_leaderboard_entry_array ( ) const
Returns a MetaPlatformSDK_LeaderboardEntryArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LeaderboardUpdateStatus get_leaderboard_update_status ( ) const
Returns a MetaPlatformSDK_LeaderboardUpdateStatus if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LinkedAccountArray get_linked_account_array ( ) const
Returns a MetaPlatformSDK_LinkedAccountArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LivestreamingApplicationStatus get_livestreaming_application_status ( ) const
Returns a MetaPlatformSDK_LivestreamingApplicationStatus if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LivestreamingStartResult get_livestreaming_start_result ( ) const
Returns a MetaPlatformSDK_LivestreamingStartResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LivestreamingStatus get_livestreaming_status ( ) const
Returns a MetaPlatformSDK_LivestreamingStatus if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_LivestreamingVideoStats get_livestreaming_video_stats ( ) const
Returns a MetaPlatformSDK_LivestreamingVideoStats if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_MicrophoneAvailabilityState get_microphone_availability_state ( ) const
Returns a MetaPlatformSDK_MicrophoneAvailabilityState if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_Message get_native_message ( ) const
Returns a MetaPlatformSDK_Message if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_NetSyncConnection get_net_sync_connection ( ) const
Returns a MetaPlatformSDK_NetSyncConnection if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_NetSyncSessionArray get_net_sync_session_array ( ) const
Returns a MetaPlatformSDK_NetSyncSessionArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_NetSyncSessionsChangedNotification get_net_sync_sessions_changed_notification ( ) const
Returns a MetaPlatformSDK_NetSyncSessionsChangedNotification if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_NetSyncSetSessionPropertyResult get_net_sync_set_session_property_result ( ) const
Returns a MetaPlatformSDK_NetSyncSetSessionPropertyResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_NetSyncVoipAttenuationValueArray get_net_sync_voip_attenuation_value_array ( ) const
Returns a MetaPlatformSDK_NetSyncVoipAttenuationValueArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_OrgScopedID get_org_scoped_id ( ) const
Returns a MetaPlatformSDK_OrgScopedID if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_Party get_party ( ) const
Returns a MetaPlatformSDK_Party if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_PartyID get_party_id ( ) const
Returns a MetaPlatformSDK_PartyID if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_PartyUpdateNotification get_party_update_notification ( ) const
Returns a MetaPlatformSDK_PartyUpdateNotification if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_PidArray get_pid_array ( ) const
Returns a MetaPlatformSDK_PidArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_PlatformInitialize get_platform_initialize ( ) const
Returns a MetaPlatformSDK_PlatformInitialize if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_ProductArray get_product_array ( ) const
Returns a MetaPlatformSDK_ProductArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_Purchase get_purchase ( ) const
Returns a MetaPlatformSDK_Purchase if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_PurchaseArray get_purchase_array ( ) const
Returns a MetaPlatformSDK_PurchaseArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_RejoinDialogResult get_rejoin_dialog_result ( ) const
Returns a MetaPlatformSDK_RejoinDialogResult if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_SdkAccountArray get_sdk_account_array ( ) const
Returns a MetaPlatformSDK_SdkAccountArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_SendInvitesResult get_send_invites_result ( ) const
Returns a MetaPlatformSDK_SendInvitesResult if that is the payload of this message; otherwise, it returns null.
Returns a MetaPlatformSDK_ShareMediaResult if that is the payload of this message; otherwise, it returns null.
String get_string ( ) const
Returns a String if that is the payload of this message; otherwise, it returns "".
MetaPlatformSDK_SystemVoipState get_system_voip_state ( ) const
Returns a MetaPlatformSDK_SystemVoipState if that is the payload of this message; otherwise, it returns null.
String get_type_as_string ( ) const
Returns a String representing the message type.
MetaPlatformSDK_User get_user ( ) const
Returns a MetaPlatformSDK_User if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_UserAccountAgeCategory get_user_account_age_category ( ) const
Returns a MetaPlatformSDK_UserAccountAgeCategory if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_UserArray get_user_array ( ) const
Returns a MetaPlatformSDK_UserArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_UserCapabilityArray get_user_capability_array ( ) const
Returns a MetaPlatformSDK_UserCapabilityArray if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_UserDataStoreUpdateResponse get_user_data_store_update_response ( ) const
Returns a MetaPlatformSDK_UserDataStoreUpdateResponse if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_UserProof get_user_proof ( ) const
Returns a MetaPlatformSDK_UserProof if that is the payload of this message; otherwise, it returns null.
MetaPlatformSDK_UserReportID get_user_report_id ( ) const
Returns a MetaPlatformSDK_UserReportID if that is the payload of this message; otherwise, it returns null.
bool is_error ( ) const
Returns true if this message is an error; otherwise, it returns false.
bool is_success ( ) const
Returns true if this message is a success; otherwise, it returns false.