TriggeredCommandForm

public class TriggeredCommandForm: NSObject, NSCoding

Form of a command of a trigger.

This class contains data in order to create or modify Command in Trigger with followings methods:

Mandatory data are followings:

Schema name
Schema version
List of actions

Optional data are followings:

Target thing id
Title of a schema
Description of a schema
Meta data of a schema

Properties

schemaName
Schema name.
Declaration
Swift

public let schemaName: String
schemaVersion
Schema version.
Declaration
Swift

public let schemaVersion: Int


                    
                    
                    actions

List of actions.

Declaration

Swift

public let actions: [Dictionary<String, AnyObject>]

targetID
Target thing ID.
Declaration
Swift

public let targetID: TypedID?
title
Title of a command.
Declaration
Swift

public let title: String?
commandDescription
Description of a command.
Declaration
Swift

public let commandDescription: String?


                    
                    
                    metadata

Meta data of ad command.

Declaration

Swift

public let metadata: Dictionary<String, AnyObject>?

Initializing TriggeredCommandForm instance.


                    
                    
                    init(schemaName:schemaVersion:actions:targetID:title:commandDescription:metadata:)

Initializer of TriggeredCommandForm instance.

Parameter

Parameter schemaName: Schema name.

Parameter

Parameter schemaVersion: Schema version.

Parameter

Parameter actions: List of actions. Must not be empty.

Parameter

Parameter targetID: target thing ID.

Parameter

Parameter title: Title of a command. This should be equal or less than 50 characters.

Parameter

Parameter description: Description of a comand. This should be equal or less than 200 characters.

Parameter

Parameter metadata: Meta data of a command.

Declaration

Swift

public init(schemaName: String,
                schemaVersion: Int,
                actions: [Dictionary<String, AnyObject>],
                targetID: TypedID? = nil,
                title: String? = nil,
                commandDescription: String? = nil,
                metadata: Dictionary<String, AnyObject>? = nil)

Parameters

`schemaName`	Schema name.
`schemaVersion`	Schema version.
`actions`	List of actions. Must not be empty.
`targetID`	target thing ID.
`title`	Title of a command. This should be equal or less than 50 characters.
`description`	Description of a comand. This should be equal or less than 200 characters.
`metadata`	Meta data of a command.


                    
                    
                    init(command:schemaName:schemaVersion:actions:targetID:title:commandDescription:metadata:)

Initializer of TriggeredCommandForm instance.

This initializer copies following fields:

If you specify optional arguments corresponding to above mentioned value, Optional argument values win against the Command values.

Parameter

Parameter command: source command of this TriggeredCommandForm.

Parameter

Parameter schemaName: Schema name.

Parameter

Parameter schemaVersion: Schema version.

Parameter

Parameter actions: List of actions. Must not be empty.

Parameter

Parameter targetID: target thing ID.

Parameter

Parameter title: Title of a command. This should be equal or less than 50 characters.

Parameter

Parameter description: Description of a comand. This should be equal or less than 200 characters.

Parameter

Parameter metadata: Meta data of a command.

Declaration

Swift

public init(command: Command,
                schemaName: String? = nil,
                schemaVersion: Int? = nil,
                actions: [Dictionary<String, AnyObject>]? = nil,
                targetID: TypedID? = nil,
                title: String? = nil,
                commandDescription: String? = nil,
                metadata: Dictionary<String, AnyObject>? = nil)

Parameters

`command`	source command of this TriggeredCommandForm.
`schemaName`	Schema name.
`schemaVersion`	Schema version.
`actions`	List of actions. Must not be empty.
`targetID`	target thing ID.
`title`	Title of a command. This should be equal or less than 50 characters.
`description`	Description of a comand. This should be equal or less than 200 characters.
`metadata`	Meta data of a command.


                    
                    
                    encodeWithCoder(aCoder:)

Undocumented

Declaration

Swift

public class TriggeredCommandForm: NSObject, NSCoding


                    
                    
                    init(coder:)

Undocumented

Declaration

Swift

public class TriggeredCommandForm: NSObject, NSCoding