Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
Panel
bgColor#EAE6FF

What You

will learn

Will Learn

  • How to control the operation mode of your exhibit

  • How to monitor exhibit health with Statuses

  • How to create and trigger custom exhibit events with Controls

  • How to create custom configurations with Settings

  • How to log info, debug, and error messages to Gumband

  • How to measure user interactions with reporting events

  • How to create and trigger custom email notifications

...

There is no event listener for when a status changes, since statuses are one-way communications from the exhibit to the Gumband cloud. A status can be updated through the GumbandSDK.setStatus(statusID: string, newStatus: string) function in the SDK. For example, imagine that a screen should toggle on and off according to the operation mode:

...

Since settings are two way communications, they can be set by the exhibit through the GumbandSDK.setSetting(settingID, newSettingValue: string | number | boolean) function in the SDK, and a setting change event from the Gumband cloud can be listened for through the Sockets.SETTING_RECEIVED event listener callback:

...

Recording events to measure user interaction is easy with the Gumband SDK. Simply use the thisGumbandSDK.gumbandSDK.event.create(eventName: string, data: any) function to dispatch new events to the Gumband cloud. For example, the following will dispatch 16 fake button press events:

...

When a critical component of your exhibit goes down, you want know right away. Gumband has email notifications built-in for a number of use cases, such as Operation Mode change and the Exhibit going offline/online, but you can also define your own custom email notifications with the this.gumbandSDKGumbandSDK.notifications.email(customMessage: string):

...