Show:

Streams userChooser Class

Defined in: platform/plugins/Streams/handlers/Streams/userChooser/tool.php:9
Module: Streams-tools

Interface for selecting an app user

Constructor

Streams userChooser

(
  • [$options]
)

Defined in platform/plugins/Streams/handlers/Streams/userChooser/tool.php:9

Parameters:

  • [$options] Array optional

    this object contains function parameters

    • [onChoose] String optional

      is triggered with (userId, avatar) parameters when a user is chosen

    • [delay=500] Integer optional

      how long to delay before sending a request to allow more characters to be entered

    • [exclude] Array optional

      hash of {userId: true}, where userId are the ids of the users to exclude from the results. Defaults to id of logged-in user, if logged in.

Item Index