MetaPlatformSDK
Inherits: Object
A singleton that is your main entry-point for working with Meta's Platform SDK.
Description
The MetaPlatformSDK singleton is your main entry-point for working with Meta's Platform SDK.
Be sure to initialize the Platform SDK using initialize_platform_async or initialize_platform before calling any other methods.
Methods
Signals
notification_received ( MetaPlatformSDK_Message message )
Emitted when a notification message is received.
Enumerations
enum PartyUpdateAction:
PartyUpdateAction PARTY_UPDATE_ACTION_UNKNOWN = 0
An unknown party update action type.
PartyUpdateAction PARTY_UPDATE_ACTION_JOIN = 1
Indicates the user joined the party.
PartyUpdateAction PARTY_UPDATE_ACTION_LEAVE = 2
Indicates the user left the party.
PartyUpdateAction PARTY_UPDATE_ACTION_INVITE = 3
Indicates the user was invited to the party.
PartyUpdateAction PARTY_UPDATE_ACTION_UNINVITE = 4
Indicates the user was uninvited to the party.
enum ChallengeCreationType:
ChallengeCreationType CHALLENGE_CREATION_TYPE_UNKNOWN = 0
An unknown challenge creation type.
ChallengeCreationType CHALLENGE_CREATION_TYPE_USER_CREATED = 1
The challenge was created by a User. This means that a regular user of the app created the challenge, and it may be a community-driven challenge or a personal challenge created by the user for themselves or others.
ChallengeCreationType CHALLENGE_CREATION_TYPE_DEVELOPER_CREATED = 2
The challenge was created by the app developer. This means that the challenge was created by the team behind the app, and it may be an official challenge or a special event created by the developers to engage with the community or promote specific features of the app.
enum ServiceProvider:
ServiceProvider SERVICE_PROVIDER_UNKNOWN = 0
Using an unknown service provider.
ServiceProvider SERVICE_PROVIDER_DROPBOX = 1
Using Dropbox as the service provider.
ServiceProvider SERVICE_PROVIDER_FACEBOOK = 2
Using Facebook as the service provider.
ServiceProvider SERVICE_PROVIDER_GOOGLE = 3
Using Google as the service provider.
ServiceProvider SERVICE_PROVIDER_INSTAGRAM = 4
Using Instagram as the service provider.
ServiceProvider SERVICE_PROVIDER_REMOTE_MEDIA = 5
Using a remote media service provider.
An unknown share media status.
The media was shared.
The media share was canceled.
enum ProductType:
ProductType PRODUCT_TYPE_UNKNOWN = 0
ProductType PRODUCT_TYPE_DURABLE = 1
This product is a durable IAP item that can be consumed multiple times. It can be purchased only once.
ProductType PRODUCT_TYPE_CONSUMABLE = 2
This product is an IAP item that can be consumed only once. It can only be purchased again after it is consumed.
ProductType PRODUCT_TYPE_SUBSCRIPTION = 3
This product represents a subscription. Subscriptions provide a way for users to purchase your app or its premium content by way of a recurring payment model.
enum NetSyncVoipStreamMode:
NetSyncVoipStreamMode NET_SYNC_VOIP_STREAM_MODE_UNKNOWN = 0
An unknown VoIP stream type.
NetSyncVoipStreamMode NET_SYNC_VOIP_STREAM_MODE_AMBISONIC = 1
Represents the ambisonic stream mode the VoIP stream uses. It is the default value of MetaPlatformSDK_NetSyncOptions.set_voip_stream_default. Since it allows for the creation of immersive, surround sound experiences that simulate real-world audio environments, it typically used in virtual reality (VR) and augmented reality (AR) applications.
NetSyncVoipStreamMode NET_SYNC_VOIP_STREAM_MODE_MONO = 2
Represents the mono stream mode the VoIP stream uses. The advantages mono stream mode has over ambisonic stream mode is the audio encoding and decoding require less computational resources and thus audio streams require less bandwidth. So it is typically used in applications with limited network resources.
enum OfferTerm:
OfferTerm OFFER_TERM_UNKNOWN = 0
An unknown offer term.
OfferTerm OFFER_TERM_WEEKLY = 1
Represents that the offer term is weekly. This means that the offer will be valid for a period of one week from the date of purchase.
OfferTerm OFFER_TERM_BIWEEKLY = 2
Represents that the offer term is biweekly. This means that the offer will be valid for a period of two weeks from the date of purchase.
OfferTerm OFFER_TERM_MONTHLY = 3
Represents that the offer term is monthly. This means that the offer will be valid for a period of one month from the date of purchase.
OfferTerm OFFER_TERM_QUARTERLY = 4
Represents that the offer term is quarterly. This means that the offer will be valid for a period of three months from the date of purchase.
OfferTerm OFFER_TERM_SEMIANNUAL = 5
Represents that the offer term is every 6 months. This means that the offer will be valid for a period of six months from the date of purchase.
OfferTerm OFFER_TERM_ANNUAL = 6
Represents that the offer term is annual. This means that the offer will be valid for a period of one year from the date of purchase.
OfferTerm OFFER_TERM_BIANNUAL = 7
Represents that the offer term is every 2 years. This means that the offer will be valid for a period of two years from the date of purchase.
enum TimeWindow:
TimeWindow TIME_WINDOW_UNKNOWN = 0
An unknown time window.
TimeWindow TIME_WINDOW_ONE_HOUR = 1
A time window of one hour.
TimeWindow TIME_WINDOW_ONE_DAY = 2
A time window of one day.
TimeWindow TIME_WINDOW_ONE_WEEK = 3
A time window of one week.
TimeWindow TIME_WINDOW_THIRTY_DAYS = 4
A time window of 30 days.
TimeWindow TIME_WINDOW_NINETY_DAYS = 5
A time window of 90 days.
enum MessageType:
MessageType MESSAGE_UNKNOWN = 0
This value should never appear on the message queue. If it does, it indicates that something has gone horribly, horribly wrong.
MessageType MESSAGE_ABUSE_REPORT_REPORT_REQUEST_HANDLED = 1267661958
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_ADD_COUNT = 65495601
Indicates MetaPlatformSDK_Message.get_achievement_update should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_ADD_FIELDS = 346693929
Indicates MetaPlatformSDK_Message.get_achievement_update should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_GET_ALL_DEFINITIONS = 64177549
Indicates MetaPlatformSDK_Message.get_achievement_definition_array should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_GET_ALL_PROGRESS = 1335877149
Indicates MetaPlatformSDK_Message.get_achievement_progress_array should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_GET_DEFINITIONS_BY_NAME = 1653670332
Indicates MetaPlatformSDK_Message.get_achievement_definition_array should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_GET_NEXT_ACHIEVEMENT_DEFINITION_ARRAY_PAGE = 712888917
Indicates MetaPlatformSDK_Message.get_achievement_definition_array should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_GET_NEXT_ACHIEVEMENT_PROGRESS_ARRAY_PAGE = 792913703
Indicates MetaPlatformSDK_Message.get_achievement_progress_array should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_GET_PROGRESS_BY_NAME = 354837425
Indicates MetaPlatformSDK_Message.get_achievement_progress_array should be called to get the message payload.
MessageType MESSAGE_ACHIEVEMENTS_UNLOCK = 1497156573
Indicates MetaPlatformSDK_Message.get_achievement_update should be called to get the message payload.
MessageType MESSAGE_APPLICATION_LIFECYCLE_GET_REGISTERED_PIDS = 82169698
Indicates MetaPlatformSDK_Message.get_pid_array should be called to get the message payload.
MessageType MESSAGE_APPLICATION_LIFECYCLE_GET_SESSION_KEY = 984570141
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_APPLICATION_LIFECYCLE_REGISTER_SESSION_KEY = 1303818232
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_APPLICATION_CANCEL_APP_DOWNLOAD = 2082496734
Indicates MetaPlatformSDK_Message.get_app_download_result should be called to get the message payload.
MessageType MESSAGE_APPLICATION_CHECK_APP_DOWNLOAD_PROGRESS = 1429514532
Indicates MetaPlatformSDK_Message.get_app_download_progress_result should be called to get the message payload.
MessageType MESSAGE_APPLICATION_GET_VERSION = 1751583246
Indicates MetaPlatformSDK_Message.get_application_version should be called to get the message payload.
MessageType MESSAGE_APPLICATION_INSTALL_APP_UPDATE_AND_RELAUNCH = 343960453
Indicates MetaPlatformSDK_Message.get_app_download_result should be called to get the message payload.
MessageType MESSAGE_APPLICATION_LAUNCH_OTHER_APP = 1424151032
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_APPLICATION_START_APP_DOWNLOAD = 1157365870
Indicates MetaPlatformSDK_Message.get_app_download_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DELETE = 1834842246
Indicates MetaPlatformSDK_Message.get_asset_file_delete_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DELETE_BY_ID = 1525206354
Indicates MetaPlatformSDK_Message.get_asset_file_delete_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DELETE_BY_NAME = 1108001231
Indicates MetaPlatformSDK_Message.get_asset_file_delete_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DOWNLOAD = 289710021
Indicates MetaPlatformSDK_Message.get_asset_file_download_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DOWNLOAD_BY_ID = 755009938
Indicates MetaPlatformSDK_Message.get_asset_file_download_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DOWNLOAD_BY_NAME = 1664536314
Indicates MetaPlatformSDK_Message.get_asset_file_download_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DOWNLOAD_CANCEL = 134927303
Indicates MetaPlatformSDK_Message.get_asset_file_download_cancel_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DOWNLOAD_CANCEL_BY_ID = 1365611796
Indicates MetaPlatformSDK_Message.get_asset_file_download_cancel_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_DOWNLOAD_CANCEL_BY_NAME = 1147858170
Indicates MetaPlatformSDK_Message.get_asset_file_download_cancel_result should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_GET_LIST = 1258057588
Indicates MetaPlatformSDK_Message.get_asset_details_array should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_STATUS = 47394656
Indicates MetaPlatformSDK_Message.get_asset_details should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_STATUS_BY_ID = 1570069816
Indicates MetaPlatformSDK_Message.get_asset_details should be called to get the message payload.
MessageType MESSAGE_ASSET_FILE_STATUS_BY_NAME = 1104140880
Indicates MetaPlatformSDK_Message.get_asset_details should be called to get the message payload.
MessageType MESSAGE_AVATAR_LAUNCH_AVATAR_EDITOR = 99737939
Indicates MetaPlatformSDK_Message.get_avatar_editor_result should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_CREATE = 1750718017
Indicates MetaPlatformSDK_Message.get_challenge should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_DECLINE_INVITE = 1452177088
Indicates MetaPlatformSDK_Message.get_challenge should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_DELETE = 642287050
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET = 2002276083
Indicates MetaPlatformSDK_Message.get_challenge should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_ENTRIES = 303739999
Indicates MetaPlatformSDK_Message.get_challenge_entry_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_ENTRIES_AFTER_RANK = 143202943
Indicates MetaPlatformSDK_Message.get_challenge_entry_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_ENTRIES_BY_IDS = 828705244
Indicates MetaPlatformSDK_Message.get_challenge_entry_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_LIST = 1126581078
Indicates MetaPlatformSDK_Message.get_challenge_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_NEXT_CHALLENGES = 1534894518
Indicates MetaPlatformSDK_Message.get_challenge_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_NEXT_ENTRIES = 2135728326
Indicates MetaPlatformSDK_Message.get_challenge_entry_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_PREVIOUS_CHALLENGES = 246678541
Indicates MetaPlatformSDK_Message.get_challenge_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_GET_PREVIOUS_ENTRIES = 2026439792
Indicates MetaPlatformSDK_Message.get_challenge_entry_array should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_JOIN = 556040297
Indicates MetaPlatformSDK_Message.get_challenge should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_LEAVE = 694228709
Indicates MetaPlatformSDK_Message.get_challenge should be called to get the message payload.
MessageType MESSAGE_CHALLENGES_UPDATE_INFO = 292929120
Indicates MetaPlatformSDK_Message.get_challenge should be called to get the message payload.
MessageType MESSAGE_COWATCHING_GET_NEXT_COWATCH_VIEWER_ARRAY_PAGE = 490748210
Indicates MetaPlatformSDK_Message.get_cowatch_viewer_array should be called to get the message payload.
MessageType MESSAGE_COWATCHING_GET_PRESENTER_DATA = 1233536821
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_COWATCHING_GET_VIEWERS_DATA = 1557635663
Indicates MetaPlatformSDK_Message.get_cowatch_viewer_array should be called to get the message payload.
MessageType MESSAGE_COWATCHING_IS_IN_SESSION = 1696286852
Indicates MetaPlatformSDK_Message.get_cowatching_state should be called to get the message payload.
MessageType MESSAGE_COWATCHING_JOIN_SESSION = 1669899604
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_COWATCHING_LAUNCH_INVITE_DIALOG = 580072087
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_COWATCHING_LEAVE_SESSION = 1017005773
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_COWATCHING_REQUEST_TO_PRESENT = 2138684586
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_COWATCHING_RESIGN_FROM_PRESENTING = 1263124994
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_COWATCHING_SET_PRESENTER_DATA = 1830586630
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_COWATCHING_SET_VIEWER_DATA = 1021044774
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_DEVICE_APPLICATION_INTEGRITY_GET_INTEGRITY_TOKEN = 846310362
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_ENTITLEMENT_GET_IS_VIEWER_ENTITLED = 409688241
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_CLEAR = 1839897795
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_GET_INVITABLE_USERS = 592167921
Indicates MetaPlatformSDK_Message.get_user_array should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_GET_NEXT_APPLICATION_INVITE_ARRAY_PAGE = 83411186
Indicates MetaPlatformSDK_Message.get_application_invite_array should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_GET_SENT_INVITES = 136710833
Indicates MetaPlatformSDK_Message.get_application_invite_array should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_LAUNCH_INVITE_PANEL = 262066079
Indicates MetaPlatformSDK_Message.get_invite_panel_result_info should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_LAUNCH_MULTIPLAYER_ERROR_DIALOG = 693481252
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_LAUNCH_REJOIN_DIALOG = 360121199
Indicates MetaPlatformSDK_Message.get_rejoin_dialog_result should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_LAUNCH_ROSTER_PANEL = 896698498
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SEND_INVITES = 231461732
Indicates MetaPlatformSDK_Message.get_send_invites_result should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SET = 1734302756
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SET_DEEPLINK_MESSAGE_OVERRIDE = 1377492749
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SET_DESTINATION = 1281042058
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SET_IS_JOINABLE = 714018901
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SET_LOBBY_SESSION = 1224693182
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_GROUP_PRESENCE_SET_MATCH_SESSION = 827098296
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_IAP_CONSUME_PURCHASE = 532378329
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_IAP_GET_NEXT_PRODUCT_ARRAY_PAGE = 467225263
Indicates MetaPlatformSDK_Message.get_product_array should be called to get the message payload.
MessageType MESSAGE_IAP_GET_NEXT_PURCHASE_ARRAY_PAGE = 1196886677
Indicates MetaPlatformSDK_Message.get_purchase_array should be called to get the message payload.
MessageType MESSAGE_IAP_GET_PRODUCTS_BY_SKU = 2124073717
Indicates MetaPlatformSDK_Message.get_product_array should be called to get the message payload.
MessageType MESSAGE_IAP_GET_VIEWER_PURCHASES = 974095385
Indicates MetaPlatformSDK_Message.get_purchase_array should be called to get the message payload.
MessageType MESSAGE_IAP_GET_VIEWER_PURCHASES_DURABLE_CACHE = 1666817579
Indicates MetaPlatformSDK_Message.get_purchase_array should be called to get the message payload.
MessageType MESSAGE_IAP_LAUNCH_CHECKOUT_FLOW = 1067126029
Indicates MetaPlatformSDK_Message.get_purchase should be called to get the message payload.
MessageType MESSAGE_LANGUAGE_PACK_GET_CURRENT = 529592533
Indicates MetaPlatformSDK_Message.get_asset_details should be called to get the message payload.
MessageType MESSAGE_LANGUAGE_PACK_SET_CURRENT = 1531952096
Indicates MetaPlatformSDK_Message.get_asset_file_download_result should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET = 1792298744
Indicates MetaPlatformSDK_Message.get_leaderboard_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET_ENTRIES = 1572030284
Indicates MetaPlatformSDK_Message.get_leaderboard_entry_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET_ENTRIES_AFTER_RANK = 406293487
Indicates MetaPlatformSDK_Message.get_leaderboard_entry_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET_ENTRIES_BY_IDS = 962624508
Indicates MetaPlatformSDK_Message.get_leaderboard_entry_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET_NEXT_ENTRIES = 1310751961
Indicates MetaPlatformSDK_Message.get_leaderboard_entry_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET_NEXT_LEADERBOARD_ARRAY_PAGE = 905344667
Indicates MetaPlatformSDK_Message.get_leaderboard_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_GET_PREVIOUS_ENTRIES = 1224858304
Indicates MetaPlatformSDK_Message.get_leaderboard_entry_array should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_WRITE_ENTRY = 293587198
Indicates MetaPlatformSDK_Message.get_leaderboard_update_status should be called to get the message payload.
MessageType MESSAGE_LEADERBOARD_WRITE_ENTRY_WITH_SUPPLEMENTARY_METRIC = 1925616378
Indicates MetaPlatformSDK_Message.get_leaderboard_update_status should be called to get the message payload.
Indicates MetaPlatformSDK_Message.get_share_media_result should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_MARK_AS_READ = 1903319523
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_PARTY_GET_CURRENT = 1200830304
Indicates MetaPlatformSDK_Message.get_party should be called to get the message payload.
MessageType MESSAGE_RICH_PRESENCE_CLEAR = 1471632051
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_RICH_PRESENCE_GET_DESTINATIONS = 1483681044
Indicates MetaPlatformSDK_Message.get_destination_array should be called to get the message payload.
MessageType MESSAGE_RICH_PRESENCE_GET_NEXT_DESTINATION_ARRAY_PAGE = 1731624773
Indicates MetaPlatformSDK_Message.get_destination_array should be called to get the message payload.
MessageType MESSAGE_RICH_PRESENCE_SET = 1007973641
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_USER_AGE_CATEGORY_GET = 567009472
Indicates MetaPlatformSDK_Message.get_user_account_age_category should be called to get the message payload.
MessageType MESSAGE_USER_AGE_CATEGORY_REPORT = 776853718
Indicates MetaPlatformSDK_Message.is_success should be called to get the message payload.
MessageType MESSAGE_USER_GET = 1808768583
Indicates MetaPlatformSDK_Message.get_user should be called to get the message payload.
MessageType MESSAGE_USER_GET_ACCESS_TOKEN = 111696574
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_USER_GET_BLOCKED_USERS = 2099254614
Indicates MetaPlatformSDK_Message.get_blocked_user_array should be called to get the message payload.
MessageType MESSAGE_USER_GET_LOGGED_IN_USER = 1131361373
Indicates MetaPlatformSDK_Message.get_user should be called to get the message payload.
MessageType MESSAGE_USER_GET_LOGGED_IN_USER_FRIENDS = 1484532365
Indicates MetaPlatformSDK_Message.get_user_array should be called to get the message payload.
MessageType MESSAGE_USER_GET_LOGGED_IN_USER_MANAGED_INFO = 1891252974
MessageType MESSAGE_USER_GET_NEXT_BLOCKED_USER_ARRAY_PAGE = 2083192267
Indicates MetaPlatformSDK_Message.get_blocked_user_array should be called to get the message payload.
MessageType MESSAGE_USER_GET_NEXT_USER_ARRAY_PAGE = 645723971
Indicates MetaPlatformSDK_Message.get_user_array should be called to get the message payload.
MessageType MESSAGE_USER_GET_NEXT_USER_CAPABILITY_ARRAY_PAGE = 587854745
Indicates MetaPlatformSDK_Message.get_user_capability_array should be called to get the message payload.
MessageType MESSAGE_USER_GET_ORG_SCOPED_ID = 418426907
Indicates MetaPlatformSDK_Message.get_org_scoped_id should be called to get the message payload.
MessageType MESSAGE_USER_GET_SDK_ACCOUNTS = 1733454467
Indicates MetaPlatformSDK_Message.get_sdk_account_array should be called to get the message payload.
MessageType MESSAGE_USER_GET_USER_PROOF = 578880643
Indicates MetaPlatformSDK_Message.get_user_proof should be called to get the message payload.
MessageType MESSAGE_USER_LAUNCH_BLOCK_FLOW = 1876305192
Indicates MetaPlatformSDK_Message.get_launch_block_flow_result should be called to get the message payload.
MessageType MESSAGE_USER_LAUNCH_FRIEND_REQUEST_FLOW = 151303576
Indicates MetaPlatformSDK_Message.get_launch_friend_request_flow_result should be called to get the message payload.
MessageType MESSAGE_USER_LAUNCH_UNBLOCK_FLOW = 346172055
Indicates MetaPlatformSDK_Message.get_launch_unblock_flow_result should be called to get the message payload.
MessageType MESSAGE_VOIP_GET_MICROPHONE_AVAILABILITY = 1951195973
Indicates MetaPlatformSDK_Message.get_microphone_availability_state should be called to get the message payload.
MessageType MESSAGE_VOIP_SET_SYSTEM_VOIP_SUPPRESSED = 1161808298
Indicates MetaPlatformSDK_Message.get_system_voip_state should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_ABUSE_REPORT_REPORT_BUTTON_PRESSED = 608644972
The user has tapped the report button in the panel that appears after pressing the Oculus button.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_APPLICATION_LIFECYCLE_LAUNCH_INTENT_CHANGED = 78859427
Sent when a launch intent is received (for both cold and warm starts). The payload is the type of the intent. application_lifecycle_get_launch_details should be called to get the other details.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_ASSET_FILE_DOWNLOAD_UPDATE = 803015885
Sent to indicate download progress for asset files.
MessageType MESSAGE_NOTIFICATION_COWATCHING_API_NOT_READY = 1711880577
Sent when user is no longer copresent. Cowatching actions should not be performed.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_API_READY = 160786067
Sent when user is in copresent and cowatching is ready to go.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_IN_SESSION_CHANGED = 234434835
Sent when the current user joins/leaves the cowatching session.
Indicates MetaPlatformSDK_Message.get_cowatching_state should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_INITIALIZED = 1960397043
Sent when cowatching api has been initialized. The api is not yet ready at this stage.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_PRESENTER_DATA_CHANGED = 1309118190
Sent when the presenter updates the presenter data.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_SESSION_STARTED = 1931580316
Sent when a user has started a cowatching session whose id is reflected in the payload.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_SESSION_STOPPED = 1239866362
Sent when a cowatching session has ended.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_COWATCHING_VIEWERS_DATA_CHANGED = 1760752127
Sent when a user joins or updates their viewer data.
MessageType MESSAGE_NOTIFICATION_GROUP_PRESENCE_INVITATIONS_SENT = 1738179766
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees.
MessageType MESSAGE_NOTIFICATION_GROUP_PRESENCE_JOIN_INTENT_RECEIVED = 2000194038
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.
MessageType MESSAGE_NOTIFICATION_GROUP_PRESENCE_LEAVE_INTENT_RECEIVED = 1194846749
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.
MessageType MESSAGE_NOTIFICATION_HTTP_TRANSFER = 2111073839
Sent to indicate that more data has been read or an error occured.
MessageType MESSAGE_NOTIFICATION_LIVESTREAMING_STATUS_CHANGE = 575101294
Indicates that the livestreaming session has been updated. You can use this information to throttle your game performance or increase CPU/GPU performance.
MessageType MESSAGE_NOTIFICATION_NET_SYNC_CONNECTION_STATUS_CHANGED = 120882378
Sent when the status of a connection has changed.
MessageType MESSAGE_NOTIFICATION_NET_SYNC_SESSIONS_CHANGED = 947814198
Sent when the list of known connected sessions has changed. Contains the new list of sessions.
MessageType MESSAGE_NOTIFICATION_PARTY_PARTY_UPDATE = 487688882
Indicates that party has been updated.
MessageType MESSAGE_NOTIFICATION_VOIP_MICROPHONE_AVAILABILITY_STATE_UPDATE = 1042336599
Indicates that the current microphone availability state has been updated. Use voip_get_microphone_availability_async to extract the microphone availability state.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_VOIP_SYSTEM_VOIP_STATE = 1490179237
Sent to indicate that some part of the overall state of System VoIP has changed.
Note that the state may have changed further since the notification was generated, and that you may call the voip_get_system_voip_status or voip_get_system_voip_microphone_muted methods at any time to get the current state directly.
Indicates MetaPlatformSDK_Message.get_system_voip_state should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_VRCAMERA_GET_DATA_CHANNEL_MESSAGE_UPDATE = 1860498236
Get vr camera related webrtc data channel messages for update.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_NOTIFICATION_VRCAMERA_GET_SURFACE_UPDATE = 938610820
Get surface and update action from platform webrtc for update.
Indicates MetaPlatformSDK_Message.get_string should be called to get the message payload.
MessageType MESSAGE_PLATFORM_INITIALIZE_WITH_ACCESS_TOKEN = 896085803
Indicates MetaPlatformSDK_Message.get_platform_initialize should be called to get the message payload.
MessageType MESSAGE_PLATFORM_INITIALIZE_STANDALONE_OCULUS = 1375260172
Indicates MetaPlatformSDK_Message.get_platform_initialize should be called to get the message payload.
MessageType MESSAGE_PLATFORM_INITIALIZE_ANDROID_ASYNCHRONOUS = 450037684
Indicates MetaPlatformSDK_Message.get_platform_initialize should be called to get the message payload.
MessageType MESSAGE_PLATFORM_INITIALIZE_WINDOWS_ASYNCHRONOUS = 1839708815
Indicates MetaPlatformSDK_Message.get_platform_initialize should be called to get the message payload.
enum ReportRequestResponse:
ReportRequestResponse REPORT_REQUEST_RESPONSE_UNKNOWN = 0
Response to the platform notification that the in-app reporting flow is in an unknown state.
ReportRequestResponse REPORT_REQUEST_RESPONSE_HANDLED = 1
Response to the platform notification that the in-app reporting flow request is handled.
ReportRequestResponse REPORT_REQUEST_RESPONSE_UNHANDLED = 2
Response to the platform notification that the in-app reporting flow request is not handled.
Response to the platform notification that the in-app reporting flow is unavailable or non-existent.
enum LeaderboardFilterType:
LeaderboardFilterType LEADERBOARD_FILTER_NONE = 0
No filter enabled on the leaderboard.
LeaderboardFilterType LEADERBOARD_FILTER_FRIENDS = 1
Indicates that the leaderboard should be filtered to include only friends (bidirectional followers) of the current user.
LeaderboardFilterType LEADERBOARD_FILTER_UNKNOWN = 2
An unknown filter status.
LeaderboardFilterType LEADERBOARD_FILTER_USER_IDS = 3
Filter the leaderboard to include specific user IDs. Use this filter to get rankings for users that are competing against each other. You specify the leaderboard name and whether to start at the top, or for the results to center on the (client) user. Note that if you specify the results to center on the client user, their leaderboard entry will be included in the returned array, regardless of whether their ID is explicitly specified in the list of IDs.
enum VoipMuteState:
VoipMuteState VOIP_MUTE_STATE_UNKNOWN = 0
An unknown mute state.
VoipMuteState VOIP_MUTE_STATE_MUTED = 1
The microphone is muted.
VoipMuteState VOIP_MUTE_STATE_UNMUTED = 2
The microphone is unmuted.
enum AbuseReportType:
AbuseReportType ABUSE_REPORT_TYPE_UNKNOWN = 0
An unkown abuse report type.
AbuseReportType ABUSE_REPORT_TYPE_OBJECT = 1
A report for something besides a user, like a world.
AbuseReportType ABUSE_REPORT_TYPE_USER = 2
A report for a user's behavior or profile.
enum LivestreamingStartStatus:
LivestreamingStartStatus LIVESTREAMING_START_STATUS_SUCCESS = 1
Represents a successful start of the livestreaming session.
LivestreamingStartStatus LIVESTREAMING_START_STATUS_UNKNOWN = 0
An unknown livestream start status.
LivestreamingStartStatus LIVESTREAMING_START_STATUS_NO_PACKAGE_SET = -1
Represents an error where the package was not set during the livestreaming start process.
LivestreamingStartStatus LIVESTREAMING_START_STATUS_NO_FB_CONNECT = -2
Represents an error where Facebook Connect was not enabled during the livestreaming start process.
LivestreamingStartStatus LIVESTREAMING_START_STATUS_NO_SESSION_ID = -3
Represents an error where a session ID was not provided during the livestreaming start process.
LivestreamingStartStatus LIVESTREAMING_START_STATUS_MISSING_PARAMETERS = -4
Represents an error where required parameters were missing during the livestreaming start process.
enum SdkAccountType:
SdkAccountType SDK_ACCOUNT_TYPE_UNKNOWN = 0
An unknown SDK account type.
SdkAccountType SDK_ACCOUNT_TYPE_OCULUS = 1
An Oculus SDK account type.
SdkAccountType SDK_ACCOUNT_TYPE_FACEBOOK_GAMEROOM = 2
An Facebook Gameroom SDK account type.
enum LaunchResult:
LaunchResult LAUNCH_RESULT_UNKNOWN = 0
An unknown launch result.
LaunchResult LAUNCH_RESULT_SUCCESS = 1
The application launched successfully.
LaunchResult LAUNCH_RESULT_FAILED_ROOM_FULL = 2
The application launch failed because the room was full.
LaunchResult LAUNCH_RESULT_FAILED_GAME_ALREADY_STARTED = 3
The application launch failed because the game has already started.
LaunchResult LAUNCH_RESULT_FAILED_ROOM_NOT_FOUND = 4
The appplicatin launch failed because the room couldn't be found.
LaunchResult LAUNCH_RESULT_FAILED_USER_DECLINED = 5
The application launch failed because the user declined the invitation.
LaunchResult LAUNCH_RESULT_FAILED_OTHER_REASON = 6
The application launch failed due to some other reason.
enum LeaderboardStartAt:
LeaderboardStartAt LEADERBOARD_START_AT_TOP = 0
Indicates that the leaderboard entries should start at the top of the leaderboard.
LeaderboardStartAt LEADERBOARD_START_AT_CENTERED_ON_VIEWER = 1
Indicates that the leaderboard entries should start at the viewer's position on the leaderboard
LeaderboardStartAt LEADERBOARD_START_AT_CENTERED_ON_VIEWER_OR_TOP = 2
Indicates that the leaderboard entries should start at the viewer's position on the leaderboard, or at the top of the leaderboard if the viewer is not present.
LeaderboardStartAt LEADERBOARD_START_AT_UNKNOWN = 3
An unknown leaderboard start type.
enum AppInstallResult:
AppInstallResult APP_INSTALL_RESULT_UNKNOWN = 0
An unknown app install result type.
AppInstallResult APP_INSTALL_RESULT_LOW_STORAGE = 1
Install of the app failed due to low storage on the device.
AppInstallResult APP_INSTALL_RESULT_NETWORK_ERROR = 2
Install of the app failed due to a network error.
AppInstallResult APP_INSTALL_RESULT_DUPLICATE_REQUEST = 3
Install of the app failed because another install request for this application is already being processed by the installer.
AppInstallResult APP_INSTALL_RESULT_INSTALLER_ERROR = 4
Install of the app failed due to an internal installer error.
AppInstallResult APP_INSTALL_RESULT_USER_CANCELLED = 5
Install of the app failed because the user cancelled the install operation.
AppInstallResult APP_INSTALL_RESULT_AUTHORIZATION_ERROR = 6
Install of the app failed due to a user authorization error.
AppInstallResult APP_INSTALL_RESULT_SUCCESS = 7
Install of the app succeeded.
enum OfferType:
OfferType OFFER_TYPE_UNKNOWN = 0
An unknown offer type.
OfferType OFFER_TYPE_INTROOFFER = 1
This value indicates that the offer is an intro offer, which is typically a special promotion or discount offered to new customers.
OfferType OFFER_TYPE_FREETRIAL = 2
This value indicates that the offer is a free trial, which allows customers to try out a product or service without paying for it.
enum PlatformInitializeResult:
PlatformInitializeResult PLATFORM_INITIALIZE_SUCCESS = 0
Oculus Platform SDK initialization succeeded.
PlatformInitializeResult PLATFORM_INITIALIZE_UNINITIALIZED = -1
Oculus Platform SDK was not initialized.
PlatformInitializeResult PLATFORM_INITIALIZE_PRE_LOADED = -2
Oculus Platform SDK failed to initialize because the pre-loaded module was on a different path than the validated library.
PlatformInitializeResult PLATFORM_INITIALIZE_FILE_INVALID = -3
Oculus Platform SDK files failed to load.
PlatformInitializeResult PLATFORM_INITIALIZE_SIGNATURE_INVALID = -4
Oculus Platform SDK failed to initialize due to an invalid signature in the signed certificate.
PlatformInitializeResult PLATFORM_INITIALIZE_UNABLE_TO_VERIFY = -5
Oculus Platform SDK failed to initialize due to unable to verify the application's signature during initialization.
PlatformInitializeResult PLATFORM_INITIALIZE_VERSION_MISMATCH = -6
There was a mismatch between the version of Oculus Platform SDK used by the application and the version installed on the Oculus user's device.
PlatformInitializeResult PLATFORM_INITIALIZE_UNKNOWN = -7
Platform SDK not initialized successfully due to an unknown error.
PlatformInitializeResult PLATFORM_INITIALIZE_INVALID_CREDENTIALS = -8
Oculus Platform SDK failed to initialize because the Oculus user had an invalid account access token.
PlatformInitializeResult PLATFORM_INITIALIZE_NOT_ENTITLED = -9
Oculus Platform SDK failed to initialize because the Oculus user does not have the application entitlement.
enum NetSyncConnectionStatus:
NetSyncConnectionStatus NET_SYNC_CONNECTION_STATUS_UNKNOWN = 0
An unknown net sync connection status.
NetSyncConnectionStatus NET_SYNC_CONNECTION_STATUS_CONNECTING = 1
Indicates that the connection of the network sync has been started and the process is ongoing.
NetSyncConnectionStatus NET_SYNC_CONNECTION_STATUS_DISCONNECTED = 2
Indicates that the current status of the network sync connection is not connected.
NetSyncConnectionStatus NET_SYNC_CONNECTION_STATUS_CONNECTED = 3
Indicates that the current status of the network sync connection is connected.
enum ChallengeVisibility:
ChallengeVisibility CHALLENGE_VISIBILITY_UNKNOWN = 0
An unknown challenge visibility type.
ChallengeVisibility CHALLENGE_VISIBILITY_INVITE_ONLY = 1
Only those invited can participate in this challenge, but everyone can see it.
ChallengeVisibility CHALLENGE_VISIBILITY_PUBLIC = 2
Everyone can participate and see this challenge.
ChallengeVisibility CHALLENGE_VISIBILITY_PRIVATE = 3
Only those invited can participate and see this challenge.
enum LaunchType:
LaunchType LAUNCH_TYPE_UNKNOWN = 0
An unknown launch type.
LaunchType LAUNCH_TYPE_NORMAL = 1
Normal launch from the user's library.
LaunchType LAUNCH_TYPE_INVITE = 2
Launch from the user accepting an invite.
LaunchType LAUNCH_TYPE_COORDINATED = 3
DEPRECATED
LaunchType LAUNCH_TYPE_DEEPLINK = 4
Launched from application_launch_other_app_async.
enum MultiplayerErrorErrorKey:
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_UNKNOWN = 0
An unknown multiplayer error error key type.
Indicates that the travel destination is not available any more.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_DLC_REQUIRED = 2
Indicates that the downloadable content will be needed.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_GENERAL = 3
Indicates a broad range of general errors which are not be covered by the members of the enum.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_GROUP_FULL = 4
Indicates that the user failed to join the group because it was full.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_INVITER_NOT_JOINABLE = 5
Indicates that the user cannot invite a recepient successfully. The group presence can be set to joinable by using group_presence_set_is_joinable_async.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_LEVEL_NOT_HIGH_ENOUGH = 6
Indicates that certain features will not be available to the user in the app because the user's level does not reach to certain level.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_LEVEL_NOT_UNLOCKED = 7
Indicates that the failure occurred becasue some level has not been reached.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_NETWORK_TIMEOUT = 8
When the predefined network timeout has reached, the ongoing activity would be stopped. The dialog will use this error key to give the user the information.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_NO_LONGER_AVAILABLE = 9
Player is no longer available.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_UPDATE_REQUIRED = 10
Player must update their app.
MultiplayerErrorErrorKey MULTIPLAYER_ERROR_ERROR_KEY_TUTORIAL_REQUIRED = 11
Player must complete required tutorial.
enum NetSyncDisconnectReason:
NetSyncDisconnectReason NET_SYNC_DISCONNECT_REASON_UNKNOWN = 0
An unknown net sync disconnect reason.
NetSyncDisconnectReason NET_SYNC_DISCONNECT_REASON_LOCAL_TERMINATED = 1
Disconnect was requested.
NetSyncDisconnectReason NET_SYNC_DISCONNECT_REASON_SERVER_TERMINATED = 2
Server intentionally closed the connection.
NetSyncDisconnectReason NET_SYNC_DISCONNECT_REASON_FAILED = 3
Initial connection never succeeded.
NetSyncDisconnectReason NET_SYNC_DISCONNECT_REASON_LOST = 4
Network timeout.
enum AccountAgeCategory:
AccountAgeCategory ACCOUNT_AGE_CATEGORY_UNKNOWN = 0
An unknown account age.
AccountAgeCategory ACCOUNT_AGE_CATEGORY_CH = 1
Child age group for users between the ages of 10-12 (age may vary by region).
AccountAgeCategory ACCOUNT_AGE_CATEGORY_TN = 2
Teenage age group for users between the ages of 13-17 (age may vary by region).
AccountAgeCategory ACCOUNT_AGE_CATEGORY_AD = 3
Adult age group for users ages 18 and up (age may vary by region).
enum UserPresenceStatus:
UserPresenceStatus USER_PRESENCE_STATUS_UNKNOWN = 0
An unknown user presence status.
UserPresenceStatus USER_PRESENCE_STATUS_ONLINE = 1
The user status is currently online.
UserPresenceStatus USER_PRESENCE_STATUS_OFFLINE = 2
The user status is currently offline.
enum MediaContentType:
MediaContentType MEDIA_CONTENT_TYPE_UNKNOWN = 0
An unknown media content type.
MediaContentType MEDIA_CONTENT_TYPE_PHOTO = 1
Indicates that the media content is a photo.
enum ChallengeViewerFilter:
ChallengeViewerFilter CHALLENGE_VIEWER_FILTER_UNKNOWN = 0
An unknown challenge viewer filter type.
ChallengeViewerFilter CHALLENGE_VIEWER_FILTER_ALL_VISIBLE = 1
Returns all public and invite-only challenges in which the user is a participant or invitee. Excludes private challenges. This filter is useful for users who want to see all challenges they are involved in, regardless of their visibility settings.
ChallengeViewerFilter CHALLENGE_VIEWER_FILTER_PARTICIPATING = 2
Returns challenges in which the user is a participant. This filter is useful for users who want to see only the challenges they are actively participating in.
ChallengeViewerFilter CHALLENGE_VIEWER_FILTER_INVITED = 3
Returns challenges that the user has been invited to. This filter is useful for users who want to see only the challenges they have been explicitly invited to.
ChallengeViewerFilter CHALLENGE_VIEWER_FILTER_PARTICIPATING_OR_INVITED = 4
Returns challenges the user is either participating in or invited to. This filter is useful for users who want to see all challenges they are involved in, whether as a participant or an invitee.
enum AchievementType:
AchievementType ACHIEVEMENT_TYPE_UNKNOWN = 0
An unknown achievement type.
AchievementType ACHIEVEMENT_TYPE_SIMPLE = 1
Simple achievements are unlocked by a single event or objective completion. They are often used to reward players for completing specific tasks or milestones within the game.
AchievementType ACHIEVEMENT_TYPE_BITFIELD = 2
Bitfield achievements are unlocked when a target number of bits are set within a bitfield.
AchievementType ACHIEVEMENT_TYPE_COUNT = 3
Count achievements are unlocked when a counter reaches a defined target. The counter is incremented each time the player completes the required action, and when it reaches the target value, the achievement is unlocked.
enum SystemVoipStatus:
SystemVoipStatus SYSTEM_VOIP_STATUS_UNKNOWN = 0
An unknown system VoIP status.
System VoIP is unavailable.
SystemVoipStatus SYSTEM_VOIP_STATUS_SUPPRESSED = 2
System VoIP is suppressed.
SystemVoipStatus SYSTEM_VOIP_STATUS_ACTIVE = 3
System VoIP is active.
enum AppStatus:
AppStatus APP_STATUS_UNKNOWN = 0
An unknown app status.
AppStatus APP_STATUS_ENTITLED = 1
User has valid entitlement to the app, but it is not currently installed on the device.
AppStatus APP_STATUS_DOWNLOAD_QUEUED = 2
Download of the app is currently queued.
AppStatus APP_STATUS_DOWNLOADING = 3
Download of the app is currently in progress.
AppStatus APP_STATUS_INSTALLING = 4
Install of the app is currently in progress.
AppStatus APP_STATUS_INSTALLED = 5
App is installed on the device.
AppStatus APP_STATUS_UNINSTALLING = 6
App is being uninstalled from the device.
AppStatus APP_STATUS_INSTALL_QUEUED = 7
Install of the app is currently queued.
enum AbuseReportVideoMode:
AbuseReportVideoMode ABUSE_REPORT_VIDEO_MODE_UNKNOWN = 0
An unknown abuse report video mode.
AbuseReportVideoMode ABUSE_REPORT_VIDEO_MODE_COLLECT = 1
The UI will collect video evidence if the object_type supports it.
AbuseReportVideoMode ABUSE_REPORT_VIDEO_MODE_OPTIONAL = 2
The UI will try to collect video evidence if the object_type supports it, but will allow the user to skip that step if they wish.
AbuseReportVideoMode ABUSE_REPORT_VIDEO_MODE_SKIP = 3
The UI will not collect video evidence.
enum AppAgeCategory:
AppAgeCategory APP_AGE_CATEGORY_UNKNOWN = 0
An unknown app age category.
AppAgeCategory APP_AGE_CATEGORY_CH = 1
Child age group for users between the ages of 10-12 (age may vary by region).
AppAgeCategory APP_AGE_CATEGORY_NCH = 2
Non-child age group for users ages 13 and up (age may vary by region).
Method Descriptions
MetaPlatformSDK_Request abuse_report_report_request_handled_async ( ReportRequestResponse response )
Responds to the an abuse report request notification sent to the current app to indicate that we want to show the in-app reporting flow or that we choose to ignore the request.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request achievements_add_count_async ( String name, int count )
Adds count to the achievement with the given name. This must be a COUNT achievement. The largest number that is supported by this method is the max value of a signed 64-bit integer. If the number is larger than that, it is clamped to that max value before being passed to the servers.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_update or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementUpdate in this case.
MetaPlatformSDK_Request achievements_add_fields_async ( String name, String fields )
Unlocks fields of a BITFIELD achievement.
name: The name of the achievement to unlock.fields: A string containing either '0' or '1' characters. Every '1' will unlock the field in the corresponding position.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_update or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementUpdate in this case.
MetaPlatformSDK_Request achievements_get_all_definitions_async ( )
Requests all achievement definitions for this app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_definition_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementDefinitionArray in this case.
MetaPlatformSDK_Request achievements_get_all_progress_async ( )
Requests the progress for the user on all achievements in this app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_progress_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementProgressArray in this case.
MetaPlatformSDK_Request achievements_get_definitions_by_name_async ( PackedStringArray names )
Requests the achievement definitions that match the specified names.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_definition_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementDefinitionArray in this case.
MetaPlatformSDK_Request achievements_get_next_achievement_definition_array_page_async ( MetaPlatformSDK_AchievementDefinitionArray handle )
Gets the next page of entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_definition_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementDefinitionArray in this case.
MetaPlatformSDK_Request achievements_get_next_achievement_progress_array_page_async ( MetaPlatformSDK_AchievementProgressArray handle )
Gets the next page of entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_progress_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementProgressArray in this case.
MetaPlatformSDK_Request achievements_get_progress_by_name_async ( PackedStringArray names )
Requests the user's progress on the specified achievements.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_progress_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementProgressArray in this case.
MetaPlatformSDK_Request achievements_unlock_async ( String name )
Unlocks the achievement with the given name. This can be of any achievement type.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_achievement_update or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AchievementUpdate in this case.
MetaPlatformSDK_Request application_cancel_app_download_async ( )
Cancels an app download that is in progress. It will return a result when the download is cancelled.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_app_download_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AppDownloadResult in this case.
MetaPlatformSDK_Request application_check_app_download_progress_async ( )
Tracks download progress for an app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_app_download_progress_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AppDownloadProgressResult in this case.
MetaPlatformSDK_Request application_get_version_async ( )
Requests version information, including the version code and version name of the currently installed app and version code, version name, size and release date of the latest app update.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_application_version or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ApplicationVersion in this case.
MetaPlatformSDK_Request application_install_app_update_and_relaunch_async ( MetaPlatformSDK_ApplicationOptions deeplink_options )
Installs the app update that was previously downloaded. Once the install begins the application will exit automatically. After the installation process is complete, the app will be relaunched based on the options passed.
deeplink_options: Additional configuration for this relaunch. Optional.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_app_download_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AppDownloadResult in this case.
MetaPlatformSDK_Request application_launch_other_app_async ( int app_id, MetaPlatformSDK_ApplicationOptions deeplink_options )
Launches a different application in the user's library. If the user does not have that application installed, they will be taken to that app's page in the Oculus Store.
app_id: The ID of the app to launch.deeplink_options: Additional configuration for this requests. Optional.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_string or accessing the MetaPlatformSDK_Message.data property, which will be a String in this case.
MetaPlatformSDK_LaunchDetails application_lifecycle_get_launch_details ( )
Returns information about how the application was started.
void application_lifecycle_log_deeplink_result ( String tracking_id, LaunchResult result )
Logs if the user successfully deeplinked to a destination.
MetaPlatformSDK_Request application_start_app_download_async ( )
Starts an app download. It will return a result when the download is finished. Download progress can be monitored using application_check_app_download_progress_async.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_app_download_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AppDownloadResult in this case.
MetaPlatformSDK_Request asset_file_delete_by_id_async ( int asset_file_id )
Removes an previously installed asset file from the device by its ID. Result payload is an object containing the asset ID and file name, and a success flag.
asset_file_id: The asset file ID.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_delete_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDeleteResult in this case.
MetaPlatformSDK_Request asset_file_delete_by_name_async ( String asset_file_name )
Removes an previously installed asset file from the device by its name. Result payload is an object containing the asset ID and file name, and a success flag.
asset_file_name: The asset file name.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_delete_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDeleteResult in this case.
MetaPlatformSDK_Request asset_file_download_by_id_async ( int asset_file_id )
Downloads an asset file by its ID on demand. Result payload is an object containing the asset ID and filepath. Sends periodic MESSAGE_NOTIFICATION_ASSET_FILE_DOWNLOAD_UPDATE messages to track the downloads.
asset_file_id: The asset file ID.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_download_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDownloadResult in this case.
MetaPlatformSDK_Request asset_file_download_by_name_async ( String asset_file_name )
Downloads an asset file by its name on demand. Result payload is an object containing the asset ID and filepath. Sends periodic MESSAGE_NOTIFICATION_ASSET_FILE_DOWNLOAD_UPDATE messages to track the downloads.
asset_file_name: The asset file name.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_download_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDownloadResult in this case.
MetaPlatformSDK_Request asset_file_download_cancel_by_id_async ( int asset_file_id )
Cancels a previously spawned download request for an asset file by its ID. Result payload is an object containing the asset ID and file path, and a success flag.
asset_file_id: The asset file ID.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_download_cancel_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDownloadCancelResult in this case.
MetaPlatformSDK_Request asset_file_download_cancel_by_name_async ( String asset_file_name )
Cancels a previously spawned download request for an asset file by its name. Result payload an object containing the asset ID and file path, and a success flag.
asset_file_name: The asset file name.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_download_cancel_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDownloadCancelResult in this case.
MetaPlatformSDK_Request asset_file_get_list_async ( )
Gets an array of objects with asset file names and their associated IDs, and and whether it's currently installed.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_details_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetDetailsArray in this case.
MetaPlatformSDK_Request asset_file_status_by_id_async ( int asset_file_id )
Gets the details on a single asset: ID, file name, and whether it's currently installed.
asset_file_id: The asset file ID.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_details or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetDetails in this case.
MetaPlatformSDK_Request asset_file_status_by_name_async ( String asset_file_name )
Gets the details on a single asset: ID, file name, and whether it's currently installed.
asset_file_name: The asset file name.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_details or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetDetails in this case.
MetaPlatformSDK_Request avatar_launch_avatar_editor_async ( MetaPlatformSDK_AvatarEditorOptions options )
Launches the Avatar Editor.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_avatar_editor_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AvatarEditorResult in this case.
MetaPlatformSDK_Request challenges_decline_invite_async ( int challenge_id )
Declines an invite to a challenge.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_Challenge in this case.
MetaPlatformSDK_Request challenges_get_async ( int challenge_id )
Gets the information for a single challenge.
challenge_id: The id of the challenge whose entries to return.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_Challenge in this case.
MetaPlatformSDK_Request challenges_get_entries_after_rank_async ( int challenge_id, int limit, int after_rank )
Requests an array of challenge entries.
challenge_id: The id of the challenge whose entries to return.limit: The maximum number of entries to return.after_rank: The position after which to start. For example, 10 returns challenge results starting with the 11th user.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeEntryArray in this case.
MetaPlatformSDK_Request challenges_get_entries_async ( int challenge_id, int limit, LeaderboardFilterType filter, LeaderboardStartAt start_at )
Requests an array of challenge entries.
challenge_id: The id of the challenge whose entries to return.limit: Defines the maximum number of entries to return.filter: By using LEADERBOARD_FILTER_FRIENDS, this allows you to filter the returned values to bidirectional followers.start_at: Defines whether to center the query on the user or start at the top of the challenge.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeEntryArray in this case.
MetaPlatformSDK_Request challenges_get_entries_by_ids_async ( int challenge_id, int limit, LeaderboardStartAt start_at, PackedInt64Array user_ids )
Requests an array of challenge entries. Will return only entries matching the user IDs passed in.
challenge_id: The id of the challenge whose entries to return.limit: Defines the maximum number of entries to return.start_at: Defines whether to center the query on the user or start at the top of the challenge. If this is LEADERBOARD_START_AT_CENTERED_ON_VIEWER or LEADERBOARD_START_AT_CENTERED_ON_VIEWER_OR_TOP, then the current user's ID will be automatically added to the query.user_ids: Defines a list of user ids to get entries for.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeEntryArray in this case.
MetaPlatformSDK_Request challenges_get_list_async ( MetaPlatformSDK_ChallengeOptions challenge_options, int limit )
Requests an array of challenges.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeArray in this case.
MetaPlatformSDK_Request challenges_get_next_challenges_async ( MetaPlatformSDK_ChallengeArray handle )
Requests the next page of challenges.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeArray in this case.
MetaPlatformSDK_Request challenges_get_next_entries_async ( MetaPlatformSDK_ChallengeEntryArray handle )
Requests the next page of challenge entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeEntryArray in this case.
MetaPlatformSDK_Request challenges_get_previous_challenges_async ( MetaPlatformSDK_ChallengeArray handle )
Requests the previous page of challenges.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeArray in this case.
MetaPlatformSDK_Request challenges_get_previous_entries_async ( MetaPlatformSDK_ChallengeEntryArray handle )
Requests the previous page of challenge entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ChallengeEntryArray in this case.
MetaPlatformSDK_Request challenges_join_async ( int challenge_id )
Joins a challenge, if the current user has permission.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_Challenge in this case.
MetaPlatformSDK_Request challenges_leave_async ( int challenge_id )
Leaves a challenge, if the user has permission.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_challenge or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_Challenge in this case.
MetaPlatformSDK_Request cowatching_get_next_cowatch_viewer_array_page_async ( MetaPlatformSDK_CowatchViewerArray handle )
Gets the next page of entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_cowatch_viewer_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_CowatchViewerArray in this case.
MetaPlatformSDK_Request cowatching_get_presenter_data_async ( )
Gets the presenter data for the active cowatching session.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_string or accessing the MetaPlatformSDK_Message.data property, which will be a String in this case.
MetaPlatformSDK_Request cowatching_get_viewers_data_async ( )
Gets the viewer data of everyone who is in a cowatching session whose data was set by cowatching_set_viewer_data_async. This can be called when there is an active cowatching session.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_cowatch_viewer_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_CowatchViewerArray in this case.
MetaPlatformSDK_Request cowatching_is_in_session_async ( )
Checks whether the current user is in the current cowatching session.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_cowatching_state or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_CowatchingState in this case.
MetaPlatformSDK_Request cowatching_join_session_async ( )
Joins the current cowatching session. Viewer data can only be updated by users who are in the session.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request cowatching_launch_invite_dialog_async ( )
Launches a dialog for inviting users to cowatch in Copresent Home.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request cowatching_leave_session_async ( )
Leaves the current cowatching session. Viewer data will no longer be relevant.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request cowatching_request_to_present_async ( )
Requests to start a cowatching session as the presenter while copresent in home.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request cowatching_resign_from_presenting_async ( )
Stops being the presenter. This will end the cowatching session.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request cowatching_set_presenter_data_async ( String video_title, String presenter_data )
Sets the data that drives a cowatching session. This method is only callable by the presenter. Video title cannot exceed 100 characters, and data size is limited to 500 characters. The data will be eventually consistent across all users.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request cowatching_set_viewer_data_async ( String viewer_data )
Sets the current user's viewer data to be shared with copresent users. This can be called when there is an active cowatching session. Data size is limited to 500 characters. The data will be eventually consistent across all users.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request device_application_integrity_get_integrity_token_async ( String challenge_nonce )
Gets Device and Application Integrity Attestation JSON Web Token. The token has format of header.claims.signature encoded in base64. Header contains algorithm type (PS256) and token type (JWT).
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_string or accessing the MetaPlatformSDK_Message.data property, which will be a String in this case.
MetaPlatformSDK_Request entitlement_get_is_viewer_entitled_async ( )
Checks whether the current user is entitled to the current app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_clear_async ( )
Clears group presence for this app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_get_invitable_users_async ( MetaPlatformSDK_InviteOptions options )
Gets a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_UserArray in this case.
MetaPlatformSDK_Request group_presence_get_next_application_invite_array_page_async ( MetaPlatformSDK_ApplicationInviteArray handle )
Gets the next page of entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_application_invite_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ApplicationInviteArray in this case.
MetaPlatformSDK_Request group_presence_get_sent_invites_async ( )
Gets the application invites which have been sent by the user.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_application_invite_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ApplicationInviteArray in this case.
MetaPlatformSDK_Request group_presence_launch_invite_panel_async ( MetaPlatformSDK_InviteOptions options )
Launches the flow to allow the user to invite others to their current session. This can only be used if the user is in a joinable session.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_invite_panel_result_info or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_InvitePanelResultInfo in this case.
MetaPlatformSDK_Request group_presence_launch_multiplayer_error_dialog_async ( MetaPlatformSDK_MultiplayerErrorOptions options )
Launches an error dialog with predefined messages for common multiplayer errors.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_launch_rejoin_dialog_async ( String lobby_session_id, String match_session_id, String destination_api_name )
Launches the dialog which will allow the user to rejoin a previous lobby/match. Either the lobby_session_id or the match_session_id, or both, must be populated.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_rejoin_dialog_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_RejoinDialogResult in this case.
MetaPlatformSDK_Request group_presence_launch_roster_panel_async ( MetaPlatformSDK_RosterOptions options )
Launches the panel which displays the current users in the roster. Users with the same lobby and match session id as part of their presence will show up here.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_send_invites_async ( PackedInt64Array user_ids )
Sends application invites to the passed in user ids.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_send_invites_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_SendInvitesResult in this case.
MetaPlatformSDK_Request group_presence_set_async ( MetaPlatformSDK_GroupPresenceOptions group_presence_options )
Sets group presence for this app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_set_deeplink_message_override_async ( String deeplink_message )
Sets the user's deeplink message while keeping the other group presence parameters the same. If the destination of the user is not set, the deeplink message cannot be set as there's no deeplink message to override.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_set_destination_async ( String api_name )
Replaces the user's current destination for the provided one. All other existing group presence parameters will remain the same.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_set_is_joinable_async ( bool is_joinable )
Sets if the current user's destination and session is joinable while keeping the other group presence parameters the same. If the destination or session ids of the user is not set, they cannot be set to joinable.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_set_lobby_session_async ( String id )
Replaces the user's current lobby session id for the provided one. All other existing group presence parameters will remain the same.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request group_presence_set_match_session_async ( String id )
Replaces the user's current match session id for the provided one. All other existing group presence parameters will remain the same.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request iap_consume_purchase_async ( String sku )
Allows the consumable IAP product to be purchased again. Conceptually, this indicates that the item was used or consumed.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request iap_get_next_product_array_page_async ( MetaPlatformSDK_ProductArray handle )
Gets the next page of entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_product_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ProductArray in this case.
MetaPlatformSDK_Request iap_get_next_purchase_array_page_async ( MetaPlatformSDK_PurchaseArray handle )
Gets the next page of entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_purchase_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_PurchaseArray in this case.
MetaPlatformSDK_Request iap_get_products_by_sku_async ( PackedStringArray skus )
Retrieves a list of IAP products that can be purchased.
skus: The SKUs of the products to retrieve.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_product_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ProductArray in this case.
MetaPlatformSDK_Request iap_get_viewer_purchases_async ( )
Retrieves a list of Purchase that the Logged-In-User has made. This list will also contain consumable purchases that have not been consumed.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_purchase_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_PurchaseArray in this case.
MetaPlatformSDK_Request iap_get_viewer_purchases_durable_cache_async ( )
Retrieves a list of Purchase that the Logged-In-User has made. This list will only contain durable purchase (non-consumable) and is populated from a device cache. It is recommended in all cases to use iap_get_viewer_purchases_async first and only check the cache if that fails.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_purchase_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_PurchaseArray in this case.
MetaPlatformSDK_Request iap_launch_checkout_flow_async ( String sku )
Launches the checkout flow to purchase the existing product. Oculus Home tries to handle and fix as many errors as possible. Home returns the appropriate error message and how to resolve it, if possible. Returns a purchase on success, empty purchase on cancel, and an error on error.
sku: IAP sku for the item the user wishes to purchase.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_purchase or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_Purchase in this case.
PlatformInitializeResult initialize_platform ( String app_id, Dictionary options={} )
Synchronously initializes the Platform SDK. This method or initialize_platform_async must be called before calling any other methods (except for is_platform_initialized).
app_id: The "App ID" from the "API" tab within the developer dashboard.options: A Dictionary with the following keys:"disable_p2p_networking": (bool) Will disable peer-to-peer networking if set totrue."enable_cowatching": (bool) Will enable cowatching if set totrue.
Note: Using initialize_platform_async instead, in order to initialize asynchronously, is recommended.
MetaPlatformSDK_Request initialize_platform_async ( String app_id )
Asynchronously initializes the Platform SDK. This method or initialize_platform must be called before calling any other methods (except for is_platform_initialized).
app_id: The "App ID" from the "API" tab within the developer dashboard.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_platform_initialize or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_PlatformInitialize in this case.
bool is_platform_initialized ( ) const
Returns true if the Platform SDK has been initialized via either initialize_platform_async or initialize_platform.
MetaPlatformSDK_Request language_pack_get_current_async ( )
Gets the currently installed and selected language pack for an app in the view of the asset_details. Use language field to extract neeeded language info. A particular language can be download and installed by a user from the Oculus app on the application page.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_details or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetDetails in this case.
MetaPlatformSDK_Request language_pack_set_current_async ( String tag )
Sets the current language to specified. The parameter is the BCP47 language tag. If a language pack is not downloaded yet, spawns automatically the asset_file_download_by_name_async request, and sends periodic MESSAGE_NOTIFICATION_ASSET_FILE_DOWNLOAD_UPDATE messages to track the downloads. Once the language asset file is downloaded, call language_pack_get_current_async to retrive the data, and use the language at runtime.
tag: BCP47 language tag.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_asset_file_download_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_AssetFileDownloadResult in this case.
MetaPlatformSDK_Request leaderboard_get_async ( String leaderboard_name )
Gets the information for a single leaderboard.
leaderboard_name: The name of the leaderboard to return.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardArray in this case.
MetaPlatformSDK_Request leaderboard_get_entries_after_rank_async ( String leaderboard_name, int limit, int after_rank )
Requests a block of leaderboard entries after the given rank.
leaderboard_name: The name of the leaderboard.limit: The maximum number of entries to return.after_rank: The position after which to start. For example, 10 returns leaderboard results starting with the 11th user.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardEntryArray in this case.
MetaPlatformSDK_Request leaderboard_get_entries_async ( String leaderboard_name, int limit, LeaderboardFilterType filter, LeaderboardStartAt start_at )
Requests a block of leaderboard entries based on the given filter.
leaderboard_name: The name of the leaderboard whose entries to return.limit: Defines the maximum number of entries to return.filter: By using LEADERBOARD_FILTER_FRIENDS, this allows you to filter the returned values to bidirectional followers.start_at: Defines whether to center the query on the user or start at the top of the leaderboard.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardEntryArray in this case.
MetaPlatformSDK_Request leaderboard_get_entries_by_ids_async ( String leaderboard_name, int limit, LeaderboardStartAt start_at, PackedInt64Array user_ids )
Requests a block of leaderboard entries matching the user IDs passed in.
leaderboard_name: The name of the leaderboard whose entries to return.limit: Defines the maximum number of entries to return.start_at: Defines whether to center the query on the user or start at the top of the leaderboard. If this is LEADERBOARD_START_AT_CENTERED_ON_VIEWER or LEADERBOARD_START_AT_CENTERED_ON_VIEWER_OR_TOP, then the current user's ID will be automatically added to the query.user_ids: Defines a list of user ids to get entries for.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardEntryArray in this case.
MetaPlatformSDK_Request leaderboard_get_next_entries_async ( MetaPlatformSDK_LeaderboardEntryArray handle )
Requests the next block of leaderboard entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardEntryArray in this case.
MetaPlatformSDK_Request leaderboard_get_next_leaderboard_array_page_async ( MetaPlatformSDK_LeaderboardArray handle )
Get the next page of leaderboards.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardArray in this case.
MetaPlatformSDK_Request leaderboard_get_previous_entries_async ( MetaPlatformSDK_LeaderboardEntryArray handle )
Requests the previous block of leaderboard entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_entry_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardEntryArray in this case.
MetaPlatformSDK_Request leaderboard_write_entry_async ( String leaderboard_name, int score, PackedByteArray extra_data, bool force_update )
Writes a single entry to a leaderboard.
leaderboard_name: The leaderboard for which to write the entry.score: The score to write.extra_data: A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer.force_update: If true, the score always updates. This happens even if it is not the user's best score.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_update_status or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardUpdateStatus in this case.
MetaPlatformSDK_Request leaderboard_write_entry_with_supplementary_metric_async ( String leaderboard_name, int score, int supplementary_metric, PackedByteArray extra_data, bool force_update )
Writes a single entry to a leaderboard, including supplementary metrics.
leaderboard_name: The leaderboard for which to write the entry.score: The score to write.supplementary_metric: A metric that can be used for tiebreakers.extra_data: A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer.force_update: If true, the score always updates. This happens ecen if it is not the user's best score.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_leaderboard_update_status or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LeaderboardUpdateStatus in this case.
Launch the Share to Facebook modal via a deeplink to Home on Gear VR, allowing users to share local media files to Facebook. Accepts a postTextSuggestion string for the default text of the Facebook post. Requires a filePath string as the path to the image to be shared to Facebook. This image should be located in your app's internal storage directory. Requires a contentType indicating the type of media to be shared (only 'photo' is currently supported.).
post_text_suggestion: this text will prepopulate the facebook status text-input box within the share modal.file_path: path to the file to be shared to facebook.content_type: content type of the media to be shared.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_share_media_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_ShareMediaResult in this case.
MetaPlatformSDK_Request notification_mark_as_read_async ( int notification_id )
Mark a notification as read. This causes it to disappear from the Universal Menu, the Oculus App, Oculus Home, and in-app retrieval.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request party_get_current_async ( )
Load the party the current user is in.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_party or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_Party in this case.
MetaPlatformSDK_Request rich_presence_get_destinations_async ( )
Gets all the destinations that rich presence can be set to.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_destination_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_DestinationArray in this case.
MetaPlatformSDK_Request rich_presence_get_next_destination_array_page_async ( MetaPlatformSDK_DestinationArray handle )
Get the next page of rich presence entries.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_destination_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_DestinationArray in this case.
MetaPlatformSDK_Request user_age_category_get_async ( )
Retrieve the user age category for the current user.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user_account_age_category or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_UserAccountAgeCategory in this case.
MetaPlatformSDK_Request user_age_category_report_async ( AppAgeCategory age_category )
Report the current user's age category to Meta.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
Check if this request was successful by calling MetaPlatformSDK_Message.is_success or accessing the MetaPlatformSDK_Message.data property, which will be a bool containing the same value in this case.
MetaPlatformSDK_Request user_get_access_token_async ( )
Return an access token for this user, suitable for making REST calls against graph.oculus.com.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_string or accessing the MetaPlatformSDK_Message.data property, which will be a String in this case.
MetaPlatformSDK_Request user_get_async ( int user_id )
Retrieve the user with the given ID. This might fail if the ID is invalid or the user is blocked.
NOTE: Users will have a unique ID per application.
user_id: User ID retrieved with this application.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_User in this case.
MetaPlatformSDK_Request user_get_blocked_users_async ( )
Gets the IDs of users entitled to use the current app that are blocked by the specified user.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_blocked_user_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_BlockedUserArray in this case.
MetaPlatformSDK_Request user_get_logged_in_user_async ( )
Retrieve the currently signed in user. This call is available offline.
NOTE: This will not return the user's presence as it should always be 'online' in your application.
NOTE: Users will have a unique ID per application.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_User in this case.
MetaPlatformSDK_Request user_get_logged_in_user_friends_async ( )
Retrieve a list of the logged in user's bidirectional followers who are also entitled to use the current app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_UserArray in this case.
int user_get_logged_in_user_id ( )
Returns the id of the currently logged in user, or a 0 id if there is none.
String user_get_logged_in_user_locale ( )
Returns the currently logged-in user's locale as a string, or empty string on error. Return value format conforms to BCP47. The return value is borrowed, and should not be freed
MetaPlatformSDK_Request user_get_logged_in_user_managed_info_async ( )
Retrieve the currently signed in user's managed info. This call is not available offline.
NOTE: This will return data only if the logged in user is a managed Meta account (MMA).
MetaPlatformSDK_Request user_get_next_blocked_user_array_page_async ( MetaPlatformSDK_BlockedUserArray handle )
Get the next page of blocked users.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_blocked_user_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_BlockedUserArray in this case.
MetaPlatformSDK_Request user_get_next_user_array_page_async ( MetaPlatformSDK_UserArray handle )
Get the next page of users.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_UserArray in this case.
MetaPlatformSDK_Request user_get_next_user_capability_array_page_async ( MetaPlatformSDK_UserCapabilityArray handle )
Get the next page of user capabilities.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user_capability_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_UserCapabilityArray in this case.
MetaPlatformSDK_Request user_get_org_scoped_id_async ( int user_id )
Gets an ID which is unique per organization. Allows different apps within the same organization to identify the user.
user_id: The normal user ID, which is scoped only to the current app.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_org_scoped_id or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_OrgScopedID in this case.
MetaPlatformSDK_Request user_get_sdk_accounts_async ( )
Gets all accounts belonging to this user. Accounts are the Oculus user and x-users that are linked to this user.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_sdk_account_array or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_SdkAccountArray in this case.
MetaPlatformSDK_Request user_get_user_proof_async ( )
Part of the scheme to confirm the identity of a particular user in your backend. You can pass the result of user_get_user_proof_async and a user ID from user_get_async to your your backend. Your server can then make an HTTP request to verify their identity: https://graph.oculus.com/user_nonce_validate?nonce=USE R_PROOF&user_id=USER_ID&access_token=ACCESS_TOKEN'.
NOTE: The nonce is only good for one check and then it is invalidated.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_user_proof or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_UserProof in this case.
MetaPlatformSDK_Request user_launch_block_flow_async ( int user_id )
Launch the flow for blocking the given user. You can't follow, be followed, invited, or searched by a blocked user, for example. You can remove the block via user_launch_unblock_flow_async.
user_id: User ID of user being blocked.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_launch_block_flow_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LaunchBlockFlowResult in this case.
MetaPlatformSDK_Request user_launch_friend_request_flow_async ( int user_id )
Launch the flow for sending a follow request to a user.
user_id: User ID of user to send a follow request to.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_launch_friend_request_flow_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LaunchFriendRequestFlowResult in this case.
MetaPlatformSDK_Request user_launch_unblock_flow_async ( int user_id )
Launch the flow for unblocking a user that the viewer has blocked.
user_id: User ID of user to unblock.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_launch_unblock_flow_result or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_LaunchUnblockFlowResult in this case.
MetaPlatformSDK_Request voip_get_microphone_availability_async ( )
Gets whether the microphone is currently available to the app. This can be used to show if the user's voice is able to be heard by other users.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_microphone_availability_state or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_MicrophoneAvailabilityState in this case.
VoipMuteState voip_get_system_voip_microphone_muted ( )
Returns the System VoIP microphone's mute state.
SystemVoipStatus voip_get_system_voip_status ( )
Returns the System VoIP status.
MetaPlatformSDK_Request voip_set_system_voip_suppressed_async ( bool suppressed )
Sets whether System VoIP should be suppressed so that this app's custom VoIP can use the mic and play incoming VoIP audio. Once microphone switching functionality for the user is released, this function will no longer work. You can use voip_get_microphone_availability_async to see if the user has allowed the app access to the microphone.
Returns a MetaPlatformSDK_Request which will emit the MetaPlatformSDK_Request.completed signal on completion with a MetaPlatformSDK_Message object.
First call MetaPlatformSDK_Message.is_error to check if the request resulted in an error, or was successful.
If successful, obtain the result by calling MetaPlatformSDK_Message.get_system_voip_state or accessing the MetaPlatformSDK_Message.data property, which will be a MetaPlatformSDK_SystemVoipState in this case.