Trigger an Event
This helper function triggers a specific event on a named entity on ThingWorx Platform.
enum msgCodeEnum twApi_FireEvent(enum entityTypeEnum entityType, char * entityName, char * eventName,
twInfoTable * params, int32_t timeout, char forceConnect)
The following table describes the parameters for this helper function:
Parameter
Type
Description
entityType
Input
The type of entity that the service belongs to. Enumeration values can be found in twDefinitions.h.
entityName
Input
The name of the entity that the service belongs to.
eventName
Input
The name of the event to trigger.
params
Input
A pointer to an infotable containing the parameters to be passed in to the event. The calling function retains ownership of this pointer and is responsible for releasing the memory after the call is complete.
timeout
Input
The time (in milliseconds) to wait for a response from the platform. A value of -1 uses the DEFAULT_MESSAGE_TIMEOUT as defined in twDefaultSettings.h.
forceConnect
Input
A Boolean value. If true and the API is in the disconnected state of the duty cycle, the API forces a reconnect to send the request.
Return:
msgCodeEnum — the result of the call. Refer to src/api/twDefinitions.h for the enumeration definition.
Was this helpful?