Plugin API » Applets

Applet UI

Use these methods to chain applets together, select users or groups, or even let a user pick whether to say or play a voice dialog.

AppletUI::dropZone( $name )

To chain applets together, create dropZones in your applet user interfaces. The name is a unique way of identifying different dropZones.

Arguments

Name Type Description
$name string Name of the dropzone to be stored as, this will be the same to retrieve value with AppletInstance::getDropZoneURL()

Returns

string — html of dropZone

Usage

echo AppletUI::dropZone('next');

Output

Drop Zone

AppletUI::audioSpeechPicker( $name )

If you want to allow a user to upload their own mp3s, record a message via their phone or use the text-to-speech engine, place this in your applet interface.

Arguments

  • $name — name of audioSpeechPicker

Returns

string — html of audioSpeechPicker

Usage

echo AppletUI::audioSpeechPicker('audioSpeechPicker');

Output

Audio Speech Picker

AppletUI::userGroupPicker( $name = ‘userGroupPicker’, $label = ‘Select a User or Group’ )

If your applet needs to select a user or group of users, use this picker.

Arguments

Name Type Description
$name string Name of userGroupPicker
$label string Helper text displayed in the clickable region of the picker

Returns

string — html of userGroupPicker

Usage

echo AppletUI::userGroupPicker('userGroupPicker');

Output

User Group Picker