serverWidget.createAssistant(options)

Method Description

Creates an assistant object.

Note:

The assistant cannot be used on externally available Suitelets.

Returns

serverWidget.Assistant object

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 assistant. This title appears at the top of all assistant pages.	2015.2
`options.hideNavBar`	Boolean	optional	Indicates whether to hide the navigation bar menu. By default, set to `false`. The header appears in the top-right corner on the assistant. If set to `true`, the header on the assistant is hidden from view.	2015.2

Parameter

Type

Required / Optional

Description

Since

options.title

string

required

The title of the assistant. This title appears at the top of all assistant pages.

2015.2

options.hideNavBar

Boolean

optional

Indicates whether to hide the navigation bar menu.

By default, set to false. The header appears in the top-right corner on the assistant.

If set to true, the header on the assistant is hidden from view.

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.

          //Add additional code 
...
var assistant = serverWidget.createAssistant({
    title : 'Simple Assistant'
});
...
//Add additional code

For more information, see Sample Custom Assistant Script.

Parameters

Syntax

Related Topics