ActivityStarter Component

Properties

action
  Specifies the action that will be used to start the activity.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" action="Test action">
Code Writeable true activitystarterName.action = "Test action"
Code Readable true let variable = activitystarterName.action

activityClass
  Specifies the class part of the specific component that will be started.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" activityClass="Test activityClass">
Code Writeable true activitystarterName.activityClass = "Test activityClass"
Code Readable true let variable = activitystarterName.activityClass

activityPackage
  Specifies the package part of the specific component that will be started.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" activityPackage="Test activityPackage">
Code Writeable true activitystarterName.activityPackage = "Test activityPackage"
Code Readable true let variable = activitystarterName.activityPackage

dataType
  Specifies the MIME type to pass to the activity.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" dataType="Test dataType">
Code Writeable true activitystarterName.dataType = "Test dataType"
Code Readable true let variable = activitystarterName.dataType

dataUri
  Specifies the data URI that will be used to start the activity.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" dataUri="Test dataUri">
Code Writeable true activitystarterName.dataUri = "Test dataUri"
Code Readable true let variable = activitystarterName.dataUri

extraKey
  Specifies the extra key that will be passed to the activity. Obsolete. Should use Extras instead
Data type: string
Designer Writable true <activitystarter name="activitystarterName" extraKey="Test extraKey">
Code Writeable true activitystarterName.extraKey = "Test extraKey"
Code Readable true let variable = activitystarterName.extraKey

extraValue
  Specifies the extra value that will be passed to the activity. Obsolete. Should use Extras instead
Data type: string
Designer Writable true <activitystarter name="activitystarterName" extraValue="Test extraValue">
Code Writeable true activitystarterName.extraValue = "Test extraValue"
Code Readable true let variable = activitystarterName.extraValue

extras
  Returns the list of key-value pairs that will be passed as extra data to the activity. This can be an object or an array of arrays with two elements in each. e.g. {a:1, b:2} or [['a',1],['b',2]] when setting. Return is in the array of arrays form.
Data type: array
Designer Writable false
Code Writeable true activitystarterName.extras = [object Object]
Code Readable true let variable = activitystarterName.extras

result
  Returns the result from the activity.
Data type: string
Designer Writable false
Code Writeable false
Code Readable true let variable = activitystarterName.result

resultName
  Specifies the name that will be used to retrieve a result from the activity.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" resultName="Test resultName">
Code Writeable true activitystarterName.resultName = "Test resultName"
Code Readable true let variable = activitystarterName.resultName

resultType
  Returns the MIME type from the activity.
Data type: string
Designer Writable false
Code Writeable false
Code Readable true let variable = activitystarterName.resultType

resultUri
  Returns the URI from the activity.
Data type: string
Designer Writable false
Code Writeable false
Code Readable true let variable = activitystarterName.resultUri

class
  The styling class of the the component
Data type: string
Designer Writable true <activitystarter name="activitystarterName" class="Test class">
Code Writeable false
Code Readable false

id
  The styling id of the the component
Data type: string
Designer Writable true <activitystarter name="activitystarterName" id="Test id">
Code Writeable false
Code Readable false

name
  The name of the component that will be used to refer to it in code.
Data type: string
Designer Writable true <activitystarter name="activitystarterName" name="testComponent">
Code Writeable false
Code Readable false

Methods

Method name Description Parameters
resolveActivity Returns the name of the activity that corresponds to this ActivityStarter, or an empty string if no corresponding activity can be found.
activitystarterName.resolveActivity()
startActivity Start the activity corresponding to this ActivityStarter.
activitystarterName.startActivity()
addEventListener Method used to create event listeners.
See Events below for samples.
eventName string
eventCallbackFunction callback

Events

Event name Description Parameters
activityCanceled Event raised if this `ActivityStarter returns because the activity was canceled.
activitystarterName.addEventListener(
    "activityCanceled",
    function () {
        //Your code here
    }
)
afterActivity Event raised after this ActivityStarter returns.
activitystarterName.addEventListener(
    "afterActivity",
    function (result) {
        //Your code here
    }
)
result string