Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: ordering and formatting

...

RDKShell controls the management of composition, layout, Z order, and key handling

Methods

...

addAnimation (

...

v2)

Description:   moves the client to the front or top of the Z orderPerforms a set of animations

Arguments:

  • animations - list of animations to perform
  • client - the name of the client to move to the front

Returns: none

...

  • animate (in list) (string)
  • x - the x location
  • y - the y location
  • w - width
  • h – height
  • sx - x scale factor (double)
  • sy - y scale factor (double)
  • a - alpha/opacity level to animate to (between 0 and 100)
  • duration - duration of animation in seconds (double)
  • tween - the animation tween type.  supported tweens are: linear, exp1, exp2, exp3, inquad, incubic, inback, inelastic, outelastic, outbounce.  the default is linear (string)

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "resultmethod":"org.rdk.RDKShell.1.addAnimation", {} }

moveToBack (v1)

Description:

Arguments:

  • client - the name of the client to move to the back or bottom of the Z order

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.moveToBack", "params":{ "client": "org.rdk.Netflix" }}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

moveBehind (v1)

Description:  Moves the client behind the specified target

Arguments:

  • client - the client to move
  • target - the target in which the client will move behind

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.moveBehind", "params":{ "client": "org.rdk.Netflix", "target": "org.rdk.RDKBrowser2""params":{"animations": [{
         "client": "HtmlApp",
         "x":0, "y":0, "w":1920, "h":1080, "duration":"3"
         }, 
		 {
           "client": "ResidentApp",
           "x":0, "y":0, "w":0, "h":0, "sx":0.5, "sy":0.5, "duration":"2"
		 }
         ]}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

addKeyIntercept (v1)

Description:  Sets focus Adds a key intercept to the specified client

Arguments:

...

client application specified.  The keys are specified by key code and a set of modifiers.  Regardless of the application that has focus, key presses that match the key code and modifiers will be sent to the client application

Arguments:

  • keyCode - the key code of the key to intercept
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setFocusaddKeyIntercept", "params":{ "client": "
              "keyCode": 10, 
              "modifiers": ["alt", "shift"], 
              "client": "org.rdk.Netflix" }}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

addKeyListener (

...

v2)

Description: Kills the clientAdds a key listener to an app.  The keys are bubbled up based on their z-order

Arguments:

  • client keyCode - name the key code of the client to kill

Returns: none

...

  • key to intercept (integer)
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses (string)
  • activate - activate app on key event.  default is false (boolean)
  • propagate - propagate to the next app in the z-order.  default is true (boolean)

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.killaddKeyListener", "params":{
              "clientkeys": "org.rdk.Netflix" }}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

addKeyIntercept (v1)

Description:  Adds a key intercept to the client application specified.  The keys are specified by key code and a set of modifiers.  Regardless of the application that has focus, key presses that match the key code and modifiers will be sent to the client application

Arguments:

  • keyCode - the key code of the key to intercept
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.addKeyIntercept", "params":{ [{
              "keyCode": 49,
              "modifiers": [],
             "activate":false,
             "propagate":true
              }, {
              "keyCode": 50,
              "modifiers": [],
              "keyCodeactivate": 10false, 
              "modifierspropagate": ["alt", "shift"], true
              }],
              "client": "org.rdk.Netflix" }}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

destroy (

...

v2)

Description:   Removes the key interceptdestroys an application

Arguments:

  • keyCode client - the key code of the key to intercept
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses
  • client to destroy (string)

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.removeKeyInterceptdestroy", "params":{"keyCode": 10, "modifierscallsign": ["alt", "shift"], "client": "org.rdk.Netflix""Cobalt"}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

enableInactivityReporting (v1)

Description:   gets the screen resolutionEnables or disables inactivity reporting and events

Arguments:  none

  • enable - enables/disables inactivity reporting (boolean)

Returns:

  • w - width
  • h - height

none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getScreenResolutionenableInactivityReporting", "params":{ "enable": true}}

Response: {"jsonrpc":"2.0", "id":3, "result": {"w": 1920, "h": 1080} }

...

generateKey (

...

v2)

Description:   Sets the screen resolutionTriggers key events (key press and release)

Arguments:

  • w - width
  • h - height

Returns: none

...

  • keys - list of keys to simulate
  • keyCode - the key code of the key to intercept (integer)
  • modifiers - list of modifiers (as strings) that need to be present to intercept ("ctrl", "alt", and "shift" are supported)
  • delay – the amount of time to wait (in seconds) before sending the key event (double)
  • callsign - the app to send the key event to (optional)

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "resultmethod": {} }

getClients (v1)

Description:  Gets a list of clients

Arguments:  none

Returns:

  • clients: array
Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getClients", "params":{ }}

Response: {"jsonrpc":"2.0", "id":3, "result": { "clients": ["org.rdk.Netflix", "org.rdk.RDKBrowser2"]} }

getZOrder (v1)

Description:  returns an array of clients in Z order, starting with the top most application client first

Arguments:  none

Returns:

  • clients:  array
Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getZOrder", "params":{ "org.rdk.RDKShell.1.generateKey", "params":{
   "keys":[ {
               "keyCode": 49,
               "modifiers": [],
               "delay":1.0,
               "callsign":"appName"
             },
             {
               "keyCode": 50,
               "modifiers": [],
               "delay":2.0
             }
          ]
}}

Response: {"jsonrpc":"2.0", "id":3, "result": { "clients": ["org.rdk.Netflix", "org.rdk.RDKBrowser2"]} }

...

getAvailableTypes (

...

v2)

Description:   gets returns the bounds of the specified clientlist of application types available on the firmware.

Arguments:  

...

none

Returns:

...

list of available application types

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getBoundsgetAvailableTypes", "params":{ "client": "org.rdk.RDKBrowser2"}}

Response: {"jsonrpc":"2.0",  "id":3<number>,  "result": {”types":[
"LightningBrowser", "HtmlBrowser",            "x": 0,
             "y": 0,
             "w": 600,
             "h": 400} }

...

"Cobalt", "Netflix"], "success": true} }

getBounds (v1)

Description: sets   gets the bounds of the specified client

Arguments: 

  • client

Returns:

  • x - the x location
  • y - the y location
  • w - width
  • h - height

...


Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setBoundsgetBounds", "params":{ 
             "client": "org.rdk.RDKBrowser2"}}

Response: {"jsonrpc":"2.0", "id":3, "result": {
              "x": 0,
             "y": 0,
             "w": 600,
             "h": 400
}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

getVisibility (v1)

Description: gets the visibility of the specified client

Arguments:

  • client

Returns:

...

 }

getClients (v1)

Description:  Gets a list of clients

Arguments:  none

Returns:

  • clients: array


Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getVisibilitygetClients", "params":{ "client": "org.rdk.Netflix" }}

Response: {"jsonrpc":"2.0", "id":3, "result": { "visibleclients": true} }

...

["org.rdk.Netflix", "org.rdk.RDKBrowser2"]} }

getOpacity (v1)

Description:  gets the opacity of the specified client

Arguments:

  • client
  • visible

Returns: none

  • opacity
Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setVisibilitygetOpacity", "params":{ "client": "org.rdk.Netflix", "visible": true }}

Response: {"jsonrpc":"2.0", "id":3, "result": { "opacity": 100} }

...

getScale (

...

v2)

Description:   gets the opacity of the specified clientScale an application

Arguments:

  • client - the client to scale (string)

Returns: none

  • opacity
Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getOpacitygetScale", "params":{ "client": "org.rdk.Netflix"ResidentApp"}}

Response: {"jsonrpc":"2.0", "id":3, "result": {"sx":1.5, "opacitysy" : 1001.5} }

...

getScreenResolution (v1)

Description: Sets the opacity of the given client  gets the screen resolution

Arguments:  none

  • client
  • opacity

Returns: noneReturns:

  • w - width
  • h - height


Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setOpacitygetScreenResolution", "params":{ "client": "org.rdk.Netflix", "opacity": 100}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

enableInactivityReporting (v1)

Description: Enables or disables inactivity reporting and events

Arguments:

  • enable - enables/disables inactivity reporting (boolean)

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":"w": 1920, "h": 1080} }

getState (v2)

Description: returns the list of application types available on the firmware.

Arguments: none

Returns:

  • state – state of the runtime (e.g. ["resumed", "suspended"]) (string)
  • callsign – callsign of the runtime (string) uri – the uri/url the package is set to (string)


Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.enableInactivityReportinggetState", "params":{ "enable": true}}

Response:  {"jsonrpc":"2.0",  "id":3<number>,  "result": {} }

setInactivityInterval (v1)

Description: Sets the inactivity notification interval

Arguments:

  • interval - the inactivity event interval in minutes (integer)

Returns: none

Code Block
Request : {"jsonrpc":"2.0"runtimes":[

{"callsign":"netflix1", "idstate":3"suspended", "methoduri":"org.rdk.RDKShell.1.setInactivityInterval", "params":{ "interval": 15}}

Response: {"jsonrpc":"2.0https://…. "},

{"callsign":"cobalt1", "state":"resumed", "iduri":3"https://…. "}
], "resultsuccess": {true} }

...

getSystemResourceInfo (v2)

Description: Adds a key listener to an app.  The keys are bubbled up based on their z-orderreturns the list of application types available on the firmware.

Arguments:

  • keyCode - the key code of the key to intercept (integer)
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses (string)
  • activate - activate app on key event.  default is false (boolean)
  • propagate - propagate to the next app in the z-order.  default is true (boolean)

Returns: none

...

none

Returns:

  • callsign – callsign of the runtime (string)
  • ram – the amount of memory the runtime is consuming in kB (integer)
  • vram – the amount of graphics memory runtime is using in kB (integer) (if supported)

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.addKeyListenergetSystemResourceInfo", "params":{}}

Response:              "keys": [{
              "keyCode": 49,
              "modifiers": [],
             "activate":false,
             "propagate":true
              }, {
              "keyCode": 50,
              "modifiers": [],
             "activate":false,
             "propagate":true
              }],
              {"jsonrpc":"2.0", "id":<number>, "result": {"runtimes":[
{"callsign":"netflix1", "ram":123, "vram":50},
{"callsign":"html1", "ram":123, "vram":50},
{"callsign":”cobalt1", "ram":123, "vram":50}], "success": true} }

getVisibility (v1)

Description: gets the visibility of the specified client

Arguments:

  • client

Returns:

  • visible


Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getVisibility", "params":{ "client": "org.rdk.Netflix" }}}

Response: {"jsonrpc":"2.0", "id":3, "result": {"visible": true} }

...

getZOrder (

...

v1)

Description: Removes a key listener for an app  returns an array of clients in Z order, starting with the top most application client first

Arguments:

  • keyCode - the key code of the key to intercept (integer)
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses (string)

Returns: none  none

Returns:

  • clients:  array
Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.removeKeyListenergetZOrder", "params":{ }}

Response: {"keysjsonrpc": [{
              "keyCode": 49,
              "modifiers": []
              }, {
              "keyCode": 50,
              "modifiers": []
              }],
              "client": "2.0", "id":3, "result": { "clients": ["org.rdk.Netflix", "org.rdk.RDKBrowser2"]} }

kill (v1)

Description: Kills the client

Arguments:

  • client - name of the client to kill

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.kill", "params":{ "client": "org.rdk.Netflix" }}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

launch

Description: Performs a set of animationsLaunches an application

Arguments:

  • animations - list of animations to perform
  • client - the of the client to animate (in list) (string)
  • x - the x location
  • y - the y location
  • w - width
  • h – height
  • sx - x scale factor (double)
  • sy - y scale factor (double)
  • a - alpha/opacity level to animate to (between 0 and 100)
  • duration - duration of animation in seconds (double)
  • tween - the animation tween type.  supported tweens are: linear, exp1, exp2, exp3, inquad, incubic, inback, inelastic, outelastic, outbounce.  the default is linear (string)type – the id of the runtime package or the callsign of the plugin desired to be clone (string). Required for create
  • version – version of the package. Default to latest version
  • uri: uri of app to launch
  • x, y, w, h – positioning (integers). Defaults to 0, 0, screen width, screen height
  • suspend – suspend the app on launch (boolean). Default is false
  • visible – visible on launch (boolean). Default is true. This will be false if launch to suspended is true
  • focused – app is focused on launched (boolean). Default is true. The app cannot be focused if visible is false
  • configuration – json object specifying the plugin configuration overrides. Empty by default
  • behind – client to put behind (string). Default to top of z-order
  • displayName – name of the display to create

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.addAnimationlaunch", "params":{"animationscallsign": [{
         "client": "app1", "type":"HtmlApp",
          "uri":"https://www.example.com", "x":0, "y":0, "w":1920, "h":1080, "duration}}

Response: {"jsonrpc":"3"
         }, 
		 {
           "client": "ResidentApp",
           "x":0, "y":0, "w":0, "h":0, "sx":0.5, "sy":0.5, "duration":"2"
		 }
         ]2.0", "id":3, "result": {} }

moveBehind (v1)

Description:  Moves the client behind the specified target

Arguments:

  • client - the client to move
  • target - the target in which the client will move behind

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.moveBehind", "params":{ "client": "org.rdk.Netflix", "target": "org.rdk.RDKBrowser2"}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

moveToFront (

...

v1)

Description: Scale an application  moves the client to the front or top of the Z order

Arguments:

  • client - the client to scale (string)
  • sx - x scale factor (double)
  • sy - y scale factor (double)
  • name of the client to move to the front

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setScalemoveToFront", "params":{ "client": "ResidentApp", "sx":1.5, "sy":1.5org.rdk.Netflix"}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

moveToBack (

...

v1)

Description: Scale an applicationmoves the client to the back or bottom of the Z order

Arguments:

  • client - the name of the client to scale (string)move to the back

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getScalemoveToBack", "params":{ "client": "ResidentApporg.rdk.Netflix" }}

Response: {"jsonrpc":"2.0", "id":3, "result": {"sx":1.5, "sy":1.5} }

...

removeKeyIntercept (

...

v1)

Description: Triggers key events (key press and release)  Removes the key intercept

Arguments:

...

  • keyCode - the key code of the key to intercept (integer)
  • modifiers - list of modifiers (as strings) that need to be present to intercept ("ctrl", "alt", and "shift" are supported)
  • delay – the amount of time to wait (in seconds) before sending the key event (double)
  • callsign - the app to send the key event to (optional)
  • client - the client to receive the key presses

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.generateKeyremoveKeyIntercept", "params":{
   "keyskeyCode":[ {
               "keyCode 10, "modifiers": 49["alt",
 "shift"],              "modifiers": [],
               "delay":1.0,
               "callsign":"appName"
             },
             "client": "org.rdk.Netflix"}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

removeKeyListener (v2)

Description: Removes a key listener for an app

Arguments:

  • keyCode - the key code of the key to intercept (integer)
  • modifiers - list of modifiers that need to be present to intercept
  • client - the client to receive the key presses (string)

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.removeKeyListener", "params":{"keys": [{
               "keyCode": 5049,
               "modifiers": [],
               "delay":2.0}, {
             } "keyCode": 50,
          ]
}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

launch

Description: Launches an application

...

    "modifiers": []
              }],
              "client": "org.rdk.Netflix" }}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

setBounds (v1)

Description: sets the bounds of the specified client

Arguments:

  • client
  • x - the x location
  • y - the y location
  • w - width
  • h - height

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.launchsetBounds", "params":{"callsign": "app1", "type":"HtmlApp", "uri":"https://www.example.com",  
             "client": "org.rdk.RDKBrowser2",
             "x": 0,
             "y": 0,
             "w":1920,: 600,
             "h":1080 400
}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

setFocus (

...

v1)

Description: Suspend an application  Sets focus to the specified client

Arguments:

  • callsign client - the client to suspend (string)move

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.suspendsetFocus", "params":{ "callsignclient": "Cobaltorg.rdk.Netflix" }}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

setInactivityInterval (

...

v1)

Description: destroys an applicationSets the inactivity notification interval

Arguments:

  • client interval - the client to destroy (stringinactivity event interval in minutes (integer)

Returns: none

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.destroysetInactivityInterval", "params":{ "callsigninterval": "Cobalt"15}}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

...

setOpacity (

...

v1)

Description: returns Sets the list opacity of application types available on the firmware.the given client

Arguments: none

  • client
  • opacity

Returns: list of available application typesnone

Code Block
Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getAvailableTypessetOpacity", "params":{}}

Response: {"jsonrpcclient": "2org.rdk.0Netflix",  "idopacity":<number>, "result" 100}}

Response: {”types"jsonrpc":[
"LightningBrowser", "HtmlBrowser", "Cobalt"2.0", "Netflixid"]:3, "successresult" : true{} }

...

setScale (v2)

Description: returns the list of application types available on the firmware.Arguments: none

Returns:

...

Scale an application

Arguments:

  • client - the client to scale (string)
  • sx - x scale factor (double)
  • sy - y scale factor (double)

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setScale", "params":{"client": "ResidentApp", "sx":1.5, "sy":1.5}}

Response: {"jsonrpc":"2.0", "id":3, "methodresult":"org.rdk.RDKShell.1.getState", "params":{}}

Response:  }

setScreenResolution (v1)

Description:  Sets the screen resolution

Arguments:

  • w - width
  • h - height

Returns: none

Code Block
Request: {"jsonrpc":"2.0",  "id":<number>3, "result": {"runtimesmethod":[

{"callsign":"netflix1""org.rdk.RDKShell.1.setScreenResolution", "stateparams":{ "suspendedw": 1920, "urih":"https://…. "},

{"callsign":"cobalt1", "state":"resumed", "uri":"https://…. "}
], "success": true} }

getSystemResourceInfo (v2)

Description: returns the list of application types available on the firmware.

...

Returns:

...

Code Block
Request  1080 }}

Response: {"jsonrpc":"2.0", "id":3, "result": {} }

setVisibility (v1)

Description:

Arguments:

  • client
  • visible

Returns: none

Code Block
Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getSystemResourceInfosetVisibility", "params":{ "client": "org.rdk.Netflix", "visible": true }}

Response:   {"jsonrpc":"2.0",  "id":<number>, "result"3, "result": {} }

suspend (v2)

Description: Suspend an application


Arguments:

  • callsign - the client to suspend (string)

Returns: none

Code Block
Request: {"runtimesjsonrpc":[
{"callsign":"netflix1""2.0", "id":3, "rammethod":123"org.rdk.RDKShell.1.suspend", "vramparams":50},
{"callsign":"html1", "ramCobalt"}}

Response:123, "vram":50},
{"callsignjsonrpc":”cobalt1", "ram":1232.0", "vramid":50}]3, "successresult": true{} }

Events

...

onLaunched (v1)

Description: An event that is broadcasted when a device has been inactive for a period of time.  This event is broadcasted at the frequency specified by setInactivityInterval if the device is not active.  The default frequency is 15 minutes.an runtime is launched

Parameters:

  • minutes client - The number of minutes that the device has been inactive (double)

...

  • the callsign of the plugin/runtime that was launched
  • launchType - create, activate, suspend, or resume

onDestroyed (v1)

Description: An event that is broadcasted when an runtime is launcheddestroyed

Parameters:

  • client - the callsign of the plugin/runtime that was launchedlaunchType - create, activate, suspend, or resumedestroyed

onSuspended (v1)

Description: An event that is broadcasted when an runtime is suspended

...

  • client - the callsign of the plugin/runtime that was suspended

...

onUserInactivity (v1)

Description: An event that is broadcasted when an runtime is destroyeda device has been inactive for a period of time.  This event is broadcasted at the frequency specified by setInactivityInterval if the device is not active.  The default frequency is 15 minutes.

Parameters:

  • client minutes - the callsign The number of the plugin/runtime that was destroyedminutes that the device has been inactive (double)