Assistant.addSublist(options)

Method Description

Adds a sublist to an assistant.

Note:

Only inline editor sublists are added. Other sublist types are not supported.

Returns

serverWidget.Sublist object

Supported Script Types

SuiteScript 2.x Suitelet Script Type

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.id

string

required

The internal ID for the sublist.

2015.2

options.label

string

required

The label for the sublist.

2015.2

options.type

string

required

The type of sublist to add. Currently, only the sublist type of INLINEEDITOR can be added. For more information about this type of sublist, see serverWidget.SublistType.

2016.1

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'
});
assistant.addSublist({
    id : 'idname',
    label : 'Sample label',
    type : serverWidget.SublistType.INLINEEDITOR
});
...
//Add additional code 

        

Related Topics

General Notices