Menu

Lumen help

Activation API for Web

Introduction

The Activation API allows you to customize the activation of Mesh Delivery download and upload, either based on network type or your own custom logic. These client-side setters will take precedence over the values set in the Properties section of the dashboard..

API description

dnaDownloadAllowed and dnaUploadAllowed

The default value is true and can be changed during the user's session. If set to false, users won't download or upload via the Mesh Delivery network.

 

These setters do not depend on the network type and always apply.



dnaDownloadOnCellularAllowed and dnaUploadOnCellularAllowed

The default value is false but will switch to the values defined in the dashboard right after the client contacts the Mesh Delivery backend. If set to false, the user will not download or upload through Mesh Delivery when they are connected to a network with potential data limitation (Cellular*). All video data will be sourced from the CDN.

 

These setters take precedence over any rules defined in the property section of the dashboard.



dnaDownloadOnWifiEthernetAllowed and dnaUploadOnWifiEthernetAllowed

The default value starts false but switches to the values defined in the dashboard when the client contacts the Mesh Delivery backend. If set to false, the user will not download or upload through Mesh Delivery when they are connected to a network with no data limitation (Wi-Fi and Ethernet*). All video data will be sourced from the CDN.

 

These setters take precedence over any rules defined in the property section of the dashboard.


The diagram below details the case for upload. The same can be applied for download.
 

Activation API logic

Example

To set the dnaDownloadOnWifiEthernetAllowed to false:

                Streamroot.instances[0].dnaDownloadOnWifiEthernetAllowed = false