Input Types

• ShareAction

  Defines an event that shares the given information using the device's native social sharing capabilities.

  Members

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • taskId (string | number)

    The ID of the async task.

  • text? string

    The text that should be shared.

  • title? string

    The title of the document being shared.

  • type "share"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

  • url? string

    The URL of the document being shared.

• ShareOptions

  Defines the options that a share action can have.

  Members

  • text? string

    The text that should be shared.

  • title? string

    The title of the document being shared.

  • url? string

    The URL of the document being shared.

• ShowChatBarAction

  Defines an event that shows the chat bar.

  Members

  • backgroundColor? string

    The color to use for the background.

  • foregroundColor? string

    The color to use for the foreground (text).

  • placeholder? string

    The text that the bar should have as the placeholder.

  • placeholderColor? string

    The color to use for the placeholder.

  • prefill? string

    The text that the bar should be filled with by default.

  • type "show_chat_bar"

  • visible boolean

    Whether the chat bar should be visible.

• ShowChatOptions

  Defines the possible options for showing the chat bar.

  Members

  • backgroundColor? string

    The color to use for the background.

  • foregroundColor? string

    The color to use for the foreground (text).

  • placeholder? string

    The text that the bar should have as the placeholder.

  • placeholderColor? string

    The color to use for the placeholder.

  • prefill? string

    The text that the bar should be filled with by default.

• ShowConfirmAction

  Defines an event that is used to show a confirmation dialog.

  Members

  • options ShowConfirmOptions

    The options for the confirmation dialog.

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • taskId (string | number)

    The ID of the async task.

  • type "show_confirm"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

• ShowConfirmOptions

  Defines an interface that represents the options that can be used for a confirmation dialog.

  Members

  • cancelText? string

    The text that should be shown on the "Cancel" button.

  • confirmText? string

    The text that should be shown on the "Confirm" button.

  • content string

    The content of the dialog.

  • title string

    The title that should be shown for the dialog.

• ShowInputItem

  Defines an interface that represents an item that can be displayed in a os.showInput(currentValue, options) list.

  Members

  • label string

  • value any

• ShowInputOptions

  Defines an interface for options that a show input event can use.

  Members

  • autoSelect boolean

    Whether the text in the input box should be automatically selected.

  • backgroundColor string

    The background color to use.

  • foregroundColor string

    The foreground color to use.

  • items? ShowInputItem[]

    The list of items that should be displayed.

  • placeholder string

    The placeholder for the value.

  • subtype ShowInputSuptype

    The subtype of input box to show.

  • title string

    The title that should be used for the input.

  • type ShowInputType

    The type of input box to show.

• ShowInputSuptype

  Defines the possible input types.

  A ShowInputSuptype can be one of the following values:

  • "basic"
  • "swatch"
  • "advanced"
  • "select"
  • "multiSelect"
  • "radio"
  • "checkbox"

• ShowInputType

  Defines the possible input types.

  A ShowInputType can be one of the following values:

  • "text"
  • "color"
  • "secret"
  • "date"
  • "list"

• ShowUploadAuxFileAction

  Defines an event that shows the "upload AUX file" dialog.

  Members

  • type "show_upload_aux_file"

• ShowUploadFilesAction

  Defines an event that shows the "uplaod file" dialog.

  Members

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • taskId (string | number)

    The ID of the async task.

  • type "show_upload_files"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.