Skip to content

PropertyManager

Outgoing Messages

PropertyChanged

Notifies the platform implementation about a change in a property value in the Engine that is not initiated by the platform implementation.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "PropertyManager",
            "action": "PropertyChanged"
        }
    },
    "payload": {
        "name": {{String}},
        "newValue": {{String}}        
    }
}

Payload

Property Type Required Description Example
name String Yes Name of the property.
newValue String Yes The new value of the property.

PropertyStateChanged

Notifies the platform implementation of the status of a property change after a call to setProperty().

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "PropertyManager",
            "action": "PropertyStateChanged"
        }
    },
    "payload": {
        "name": {{String}},
        "value": {{String}},
        "state": {{PropertyState}}        
    }
}

Payload

Property Type Required Description Example
name String Yes Name of the property.
value String Yes The value of the property.
state PropertyState Yes The property state.

GetPropertyReply

Reply for GetProperty message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "PropertyManager",
            "action": "GetProperty",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "name": {{String}},
        "value": {{String}}        
    }
}

Payload

Property Type Required Description Example
name String Yes The property name.
value String Yes The property value.

Incoming Messages

GetProperty

Retrieves the property setting from the Engine.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "PropertyManager",
            "action": "GetProperty"
        }
    },
    "payload": {
        "name": {{String}}        
    }
}

Payload

Property Type Required Description Example
name String Yes The property name.

SetProperty

Sets the property setting in the Engine.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "PropertyManager",
            "action": "SetProperty"
        }
    },
    "payload": {
        "name": {{String}},
        "value": {{String}}        
    }
}

Payload

Property Type Required Description Example
name String Yes The property name.
value String Yes The property value.

Enums

PropertyState

Values

Value Description
"SUCCEEDED" The property change was successful.
"FAILED" The property change failed.