Skip to content

Functions - Application

Related Oculus Platform documentation:

Signals

app_launch_intent_changed

About

This signal will be emitted when the launch intent changes. For example, if another app launched this app, and this app is already loaded in the background.

The signal will contain a String with the type of the intent.

You should call application_get_launch_details to get more information about the launch.

Functions

application_get_version

application_get_version()

Returns information about the current application.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the current app version if fulfilled. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
5
6
7
8
{
    "current_code": 5,
    "latest_code": 6,
    "current_name": "v5-alpha",
    "latest_name": "v6-beta",
    "release_date": -1,
    "update_size": "-1"
}

  • release_date is in seconds (epoch)
  • update_size is in bytes
Example 
1
2
3
4
5
6
7
8
GDOculusPlatform.application_get_version()\
.then(func(app_version : Dictionary):
    if app_version.current_code != app_version.latest_code:
        print("There is a new version of this app, please update!")
)\
.error(func(app_version_err):
    print("Unable to retrieve app version info: ", app_version_err)
)

application_launch_other_app

application_launch_other_app(app_id : String, deeplink_options : Dictionary)

Sends a request to the Oculus Platform to launch another app. The app_id argument is the ID of the other app you wish to launch. The deeplink_options argument is optional.

Returns: A GDOculusPlatformPromise that will contain a String with information about the request if fulfilled. The promise will error if the request couldn't be completed.

Example of deeplink_options: 

1
2
3
4
5
6
{
    "deeplink_message": "FROM_APP1_TO_APP2_LOBBY",
    "destination_api_name": "MY_COOL_DESTINATION",
    "lobby_session_id": "51254821626844",
    "match_session_id": "92848281510484"
}

If you decide to include deeplink_options, the only required field is deeplink_message. The other fields can be used to interact with other APIs, but they are not required.

Example 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var deeplink_options : Dictionary = {
    "deeplink_message": "GO_TO_MAIN_LOBBY"
}

GDOculusPlatform.application_launch_other_app("50125468232421", deeplink_options)\
.then(func(launch_result : String):
    print("Launch result: ", launch_result)
)\
.error(func(launch_err):
    print("Unable to launch other app: ", launch_err)
)

application_get_launch_details

application_get_launch_details()

Used to retrieve information about the launch. Can be used to deep link applications and know if another app requested the launch, among other things.

Returns: A Dictionary with information about the app's launch.

Example response: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "deeplink_message": "GO_TO_MAIN_LOBBY",
    "destination_api_name": "",
    "lobby_session_id": "",
    "match_session_id": "",
    "tracking_id": "574371645284520",
    "launch_source": "events",
    "launch_type": "DEEPLINK",
    "users": {
        "data": [
            {
                "id": "2384626433832795",
                "oculus_id": "some_id",
                "display_name": "Steve",
                "image_url": "https://example.org/some-image.png",
                "small_image_url": "",
                "presence": {
                    "presence_status": "ONLINE",
                    "presence_deeplink_message": "",
                    "presence_destination_api_name": "",
                    "presence_lobby_session_id": "",
                    "presence_match_session_id": "",
                }
            }
        ],
        "next_page_url": ""
    }
}

  • launch_type can be: DEEPLINK, COORDINATED, INVITE, NORMAL or UNKNOWN.
  • launch_source can be used to distinguish where the deeplink came from. For example, a DEEPLINK launch type could be coming from events or rich presence.
  • users is a Dictionary that could be populated with other users the current user may want to be with.

More info about next_page_url.

Example 
1
2
3
4
5
6
7
8
9
var launch_details : Dictionary = GDOculusPlatform.application_get_launch_details()

if launch_details.launch_type == "DEEPLINK":

    match launch_details.deeplink_message:
        "GO_TO_MAIN_LOBBY":
            _handle_dl_main_lobby()
        "GO_TO_STORE":
            _handle_dl_store()

application_start_app_download

application_start_app_download()

Starts downloading the latest app update (if there is one).

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the request once the operation is finished. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
{
    "install_result": "SUCCESS",
    "timestamp": 1724284356
}

  • install_result can be: UNKNOWN, LOW_STORAGE, NETWORK_ERROR, DUPLICATE_REQUEST, INSTALLER_ERROR, USER_CANCELLED, AUTHORIZATION_ERROR or SUCCESS.

Notes

According to the docs, this method will return until a problem occurs or the app finishes downloading.

Example 
1
2
3
4
5
6
7
8
GDOculusPlatform.application_start_app_download()\
.then(func(result : Dictionary):
     if result.install_result == "SUCCESS":
        GDOculusPlatform.application_install_app_update_and_relaunch()
)\
.error(func(app_update_err):
    print("Failed to start downloading app update: ", app_update_err)
)

application_check_app_download_progress

application_check_app_download_progress()

Requests the download progress of the latest app update (if there is one).

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the current app update download. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
5
{
    "total_bytes": 2048,
    "downloaded_bytes": 1024,
    "status": "DOWNLOADING"
}

  • status can be: UNKNOWN, ENTITLED, DOWNLOAD_QUEUED, DOWNLOADING, INSTALL_QUEUED, INSTALLING, INSTALLED or UNINSTALLED.
Example 
1
2
3
4
5
6
7
GDOculusPlatform.application_check_app_download_progress()\
.then(func(download_info : Dictionary):
     print("Download status: ", download_info.status)
)\
.error(func(download_info_err):
    print("Failed to get the donwload progress: ", download_info_err)
)

application_cancel_app_download

application_cancel_app_download()

Cancels the current download of the latest app update (if there is one).

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the request once the operation is finished. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
{
    "install_result": "SUCCESS",
    "timestamp": 1724284356
}

  • install_result can be: UNKNOWN, LOW_STORAGE, NETWORK_ERROR, DUPLICATE_REQUEST, INSTALLER_ERROR, USER_CANCELLED, AUTHORIZATION_ERROR or SUCCESS.
Example 
1
2
3
4
5
6
7
GDOculusPlatform.application_cancel_app_download()\
.then(func(result : Dictionary):
     print("Cancelled download of app update at: ", result.timestamp)
)\
.error(func(app_update_cancel_err):
    print("Failed to cancel downloading app update: ", app_update_cancel_err)
)

application_install_app_update_and_relaunch

application_install_app_update_and_relaunch(deeplink_options : Dictionary)

Installs the latest app update (if there is one) and launches the application again once the install finishes. The deeplink_options argument is optional.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the request. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
{
    "install_result": "LOW_STORAGE",
    "timestamp": 1724284356
}

  • install_result can be: UNKNOWN, LOW_STORAGE, NETWORK_ERROR, DUPLICATE_REQUEST, INSTALLER_ERROR, USER_CANCELLED, AUTHORIZATION_ERROR or SUCCESS.

Example of deeplink_options: 

1
2
3
4
5
6
{
    "deeplink_message": "GO_TO_LOBBY",
    "destination_api_name": "MY_SUPER_DESTINATION",
    "lobby_session_id": "51254821626844",
    "match_session_id": "92848281510484"
}

If you decide to include deeplink_options, the only required field is deeplink_message. The other fields can be used to interact with other APIs, but they are not required.

Example 
1
2
3
4
5
6
7
8
GDOculusPlatform.application_install_app_update_and_relaunch()\
.then(func(result : Dictionary):
    if result.install_result != "SUCCESS":
        print("[ERROR] %s" % result.install_result)
)\
.error(func(app_update_install_err):
    print("Failed to install latest app update: ", app_update_install_err)
)