Assistant.setSplash(options)

Method Description

Defines a splash message.

Returns

void

Supported Script Types

Suitelets

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/ui/serverWidget Module

Since

2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
`options.title`	string	required	The title of the splash screen.	2015.2
`options.text1`	string	required	Text for the splash screen	2015.2
`options.text2`	string	optional	Text for a second column on the splash screen, if desired.	2015.2

Parameter

Type

Required / Optional

Description

Since

options.title

string

required

The title of the splash screen.

2015.2

options.text1

string

required

Text for the splash screen

2015.2

options.text2

string

optional

Text for a second column on the splash screen, if desired.

2015.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/ui/serverWidget Module Script Samples.

          ...
var assistant = serverWidget.createAssistant({
    title : 'Simple Assistant'
});
assistant.setSplash({
    title: "Welcome Title!", 
    text1: "An explanation of what this assistant accomplishes.", 
    text2: "Some parting words."
});
...
//Add additional code

Parameters

Syntax

Related Topics