voltmx.gms Namespace - In App Updates

The checkForAppUpdate API checks if an update is available for the app, while the app is in use.

Syntax

voltmx.gms.checkForAppUpdate({"statusCallback" : statusCallback})

Input Parameters

statusCallback - A mandatory callback function that is executed after the execution of the API call is complete. When the API call is successful, the API returns the voltmx.gms.UPDATE_INFO_RETRIEVED statusCode.

The statusCallback function contains the result info JS Object that has the following details:

Example

function statusCallback(info) {  
	voltmx.print("updateAvailabilityStatus: " + info.updateAvailabilityStatus)  
	voltmx.print("updateTypesAllowed: " + info.updateTypesAllowed)  
	voltmx.print("updateVersionCode: " + info.updateVersionCode)  
	voltmx.print("stalenessDays: " + info.stalenessDays)  
	voltmx.print("updatePriority: " + info.updatePriority)  
	voltmx.print("totalBytes: " + info.totalBytes)  
	voltmx.print("bytesDownloaded: " + info.bytesDownloaded)  
	voltmx.print("installStatus: " + info.installStatus)  
	voltmx.print("packageName: " + info.packageName)  
        voltmx.print("statusCode: " + info.statusCode)  
}
  
voltmx.gms.checkForAppUpdate({"statusCallback" : statusCallback})

Return Value

None

Platform Availability

Android

The completeAppUpdate API must be invoked in case of a flexible app update flow, to complete the app update. Invoke this API to complete an app update that was started by using the voltmx.gms.requestForAppUpdate API and is in the DOWNLOADED state.

Syntax

voltmx.gms.completeAppUpdate({"statusCallback" : statusCallback});

Input Parameters

statusCallback - A mandatory callback function that is executed after the execution of the API call is complete. The callback function contains the result info JS Object that has the following details:

Example

function statusCallback(info) {  
                    voltmx.print(info)  
        }  
        voltmx.gms.completeAppUpdate({"statusCallback" : statusCallback})

Return Value

None

Remarks

In case of flexible update, when you invoke the completeAppUpdate API in the foreground, a full-screen UI appears and the app restarts in the background. After the update is installed, the app restarts in the foreground. If you invoke the completeAppUpdate API in the background, the app update is silently installed in the background, without obscuring the app experience.

When the user moves the app into the foreground, HCL recommends that you check if an app update is waiting to be installed. If the app has an update in the INSTALL_STATUS_DOWNLOADED state, you must display a notification to the user requesting that they install the update, as the update data occupies space on the device storage.

Platform Availability

Android

The registerAppUpdateListener API is used to register to callbacks that monitor the install status of the app update.

Note: Monitoring the update state is only required for flexible updates. Once the flexible download begins, the app must monitor the update state to recognize when the update can be installed, and to display the update progress on the app UI. For immediate updates, Google Play handles the download and installation of the update.

Syntax

voltmx.gms.registerAppUpdateListener({"statusCallback" : statusCallback})

Input Parameters

statusCallback - A mandatory callback function that is executed after the execution of the API call is complete. The callback function contains the result info JS Object that has the following details:

Example

function statusCallback(info) {  
          voltmx.print(info.statusCode)  
          voltmx.print(info.statusMessage)  
          if(info.statusCode == voltmx.gms.INSTALL_STATUS_DOWNLOADING){  
              voltmx.print(info.downloadingInfo.bytesDownloaded)  
              voltmx.print(info.downloadingInfo.totalBytes)                  
          }  
  }  
  voltmx.gms.registerAppUpdateListener({"statusCallback" : statusCallback})

Return Value

None

Remarks

• After the task is complete, HCL recommends that you unregister from the callbacks by using the voltmx.gms.unRegisterAppUpdateListener API.
• When you invoke the registerAppUpdateListener API, any registered callbacks are overridden.

Platform Availability

Android

The requestForAppUpdate API starts the specified app update flow, if an update is available, while the app is in use.

In case of flexible update, when you invoke the requestForAppUpdate API, the app update is downloaded. You must then invoke the voltmx.gms.completeAppUpdate API to install and restart the app.

In case of immediate update, when you invoke the requestForAppUpdate API, the app update is downloaded and installed, and then the app restarts.

Syntax

voltmx.gms.requestForAppUpdate({"statusCallback" : statusCallback, "updateType" : voltmx.gms.APP\_UPDATE\_TYPE\_IMMEDIATE})

Input Parameters

   Example

function statusCallback(info) {  
            voltmx.print("statusCallback" + info)  
        }  
        voltmx.gms.requestForAppUpdate({"statusCallback" : statusCallback, "updateType" : voltmx.gms.APP_UPDATE_TYPE_IMMEDIATE})

Return Value

None

Remarks

• In case of flexible flow ,the API returns one of the following status codes in the statusCallback:

• UPDATE_FLOW_CONFIRMED_BY_USER: The user has accepted the update request.
• UPDATE_FLOW_CANCELLED_BY_USER: The user has denied the update request.

• RESULT_IN_APP_UPDATE_FAILED: Something failed during the confirmation of the request. For example, the user terminates the app before responding to the update request.

• In case of immediate flow, the API returns one of the following status codes in the statusCallback:

• UPDATE_FLOW_CONFIRMED_BY_USER: The user has accepted the update request, and the update is successful. (In practice, the app must not receive this status code, as it is already updated)
• UPDATE_FLOW_CANCELLED_BY_USER: The user has denied or canceled the update.

• RESULT_IN_APP_UPDATE_FAILED: The flow failed either during the confirmation of the request, the download, or the installation of the update.

• If you invoke this API when the voltmx.gms.checkForAppUpdate API returns the UPDATE_NOT_AVAILABLE or UPDATE_UNKNOWN status codes, the API call is ignored and the same statusCode is returned.
• In case of flexible update flow, if you invoke this API when the voltmx.gms.checkForAppUpdate API returns the UPDATE_IN_PROGRESS status code, the UPDATE_IN_PROGRESS status code is returned.
• If you invoke this API when the app is running in the background, the API call is ignored and the UPDATE_NOT_ALLOWED_IN_BACKGROUND status code is returned.

• In case of immediate update flow, when the user provides consent to install the update, Google Play displays the app update progress in full-screen mode for the entire duration of the update.

  During the update, if the user closes or terminates the app, the update must continue to be downloaded and installed in the background, without any additional confirmation from the user.

  However, when the app returns to the foreground, you must verify that the update is not stalled in the UPDATE_IN_PROGRESS state. If the update is stalled, you must invoke the requestForAppUpdate API as follows:

  voltmx.gms.requestForAppUpdate({“statusCallback” : statusCallback, “updateType” : voltmx.gms.APP_UPDATE_TYPE_IMMEDIATE})

  You can track the foregroud state by registering for the onforeground callback, by using the voltmx.application.setApplicationCallbacks API.

Platform Availability

Android

The unRegisterAppUpdateListener API is used to unregister from callbacks that were registered to by using the voltmx.gms.registerAppUpdateListener API.

Syntax

voltmx.gms.unRegisterAppUpdateListener()

Input Parameters

None

Example

voltmx.gms.unRegisterAppUpdateListener()  
}

Return Value

None

Platform Availability

Android