Cabrillo JS data types

These are common data types used by Cabrillo JS APIs.

Cabrillo.Attachment

Defines an attachment.

Name	Type	Description
content_type	String	The attachment content type.
ext	String	The attachment file extension.
file_name	String	The full file name of the attachment including the extension.
sys_created_by	String	The user name of the user that created the attachment.
sys_id	String	The attachment record sys_id.
sys_updated_on	String	The date the attachment record was updated.
table_name	String	Name of the table containing the record to which the attachment is attached.
table_sys_id	String	The sys_id of the record that to which the attachment is attached.
thumbnail	String	The URL for the image thumbnail of the attachment. Only applies to image attachments.

Defines attachment options.

Name	Type	Description
isSingleSelection	Boolean	Optional. Flag that indicates whether the document picker for uploading files allows multi-selection. Valid values: - true: Only one file to upload can be selected at a time. - false: Multiple files to upload can be selected at a time. Default: False

Defines a button. Different interface contexts may support a subset of a button's properties.

Name	Type	Description
backgroundColor	String	Background color of the button or badge. A string containing hex, RGB, HSL, or an x11-named color.Note: The color can't be set for buttons in the navigation bar. The color can be set for bottom buttons.
badgeCount	Number	Number value to display on the button's badge.
buttonId	String	Required. Unique id for the button. This value is returned in the button action payload to indicate which button the user tapped.
buttonStyle	String	Used to customize the style of the button.
enabled	Boolean	Indicates whether the button is enabled.
imageName	String	Specifies an image. Possible values are: - add: Displays an add button. - back: Displays a back arrow image to navigate back. - cart: Displays a shopping cart. - close: Displays an X image to navigate back. - edit: Displays an edit button. - filter: Displays a filter button. - menu: Displays a menu button. - search: Displays a search button.
textColor	String	The text color of the badge or button. A string containing hex, RGB, HSL, or an x11-named color.Note: The color can't be set for buttons in the navigation bar. The color can be set for bottom buttons.
title	String	Title of the button. The string should be localized.

Contains the result passed from a modal window that was dismissed.

Name	Type	Description
results	Object	The result from the dismissed modal window.

Specifies a request to navigate to a list or record.

Name	Type	Description
table	String	The table to navigate to. Required for both list and record navigation.
sysId	String	The sys_id of the record to navigate to. Required for record navigation.
query	String	An encoded query for the requested list. Can be used to seed values for record navigation requests.
view	String	The list or record view.

Contains the location and dimensions of a rectangle.

Defines a spinner.

Name	Type	Description
mask	Boolean	Optional. Determines whether to display a mask behind the spinner.Valid values: - true: Displays a mask behind the spinner. - false: Does not display a mask behind the spinner. Default: false
maskColor	String	Color of the mask, if enabled.