Package org.gnome.gtk

Class Assistant

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.Window

org.gnome.gtk.Assistant

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager, Proxy

@Generated("io.github.jwharm.JavaGI")
@Deprecated
public class Assistant
extends Window
implements Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

Deprecated.

This widget will be removed in GTK 5

GtkAssistant is used to represent a complex as a series of steps.

Each step consists of one or more pages. GtkAssistant guides the user through the pages, and controls the page flow to collect the data needed for the operation.

GtkAssistant handles which buttons to show and to make sensitive based on page sequence knowledge and the Gtk.AssistantPageType of each page in addition to state information like the completed and committed page statuses.

If you have a case that doesn’t quite fit in GtkAssistants way of handling buttons, you can use the AssistantPageType.CUSTOM page type and handle buttons yourself.

GtkAssistant maintains a GtkAssistantPage object for each added child, which holds additional per-child properties. You obtain the GtkAssistantPage for a child with getPage(org.gnome.gtk.Widget).

GtkAssistant as GtkBuildable
The GtkAssistant implementation of the GtkBuildable interface exposes the actionArea as internal children with the name “action_area”.

To add pages to an assistant in GtkBuilder, simply add it as a child to the GtkAssistant object. If you need to set per-object properties, create a GtkAssistantPage object explicitly, and set the child widget as a property on it.

CSS nodes
GtkAssistant has a single CSS node with the name window and style class .assistant.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Assistant.ApplyCallback	Deprecated.
static class	Assistant.Builder<B extends Assistant.Builder<B>>	Deprecated. Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Assistant.CancelCallback	Deprecated.
static interface	Assistant.CloseCallback	Deprecated.
static interface	Assistant.EscapeCallback	Deprecated.
static interface	Assistant.PrepareCallback	Deprecated.

Nested classes/interfaces inherited from class org.gnome.gtk.Window

Window.ActivateDefaultCallback, Window.ActivateFocusCallback, Window.CloseRequestCallback, Window.EnableDebuggingCallback, Window.KeysChangedCallback, Window.WindowClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Native

Native.Native$Impl, Native.NativeInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Root

Root.Root$Impl, Root.RootInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.ShortcutManager

ShortcutManager.ShortcutManager$Impl, ShortcutManager.ShortcutManagerInterface

Constructor Summary

Constructors

Constructor	Description
Assistant()	Deprecated. Creates a new Assistant.
Assistant(MemorySegment address)	Deprecated. Create a Assistant proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addActionWidget(Widget child)	Deprecated. This widget will be removed in GTK 5
int	appendPage(Widget page)	Deprecated. This widget will be removed in GTK 5
protected Assistant	asParent()	Deprecated. Returns this instance as if it were its parent type.
static Assistant.Builder<? extends Assistant.Builder>	builder()	Deprecated. A Assistant.Builder object constructs a Assistant with the specified properties.
void	commit()	Deprecated. This widget will be removed in GTK 5
void	emitApply()	Deprecated.
void	emitCancel()	Deprecated.
void	emitClose()	Deprecated.
void	emitEscape()	Deprecated.
void	emitPrepare(@Nullable Widget page)	Deprecated.
int	getCurrentPage()	Deprecated. This widget will be removed in GTK 5
int	getNPages()	Deprecated. This widget will be removed in GTK 5
@Nullable Widget	getNthPage(int pageNum)	Deprecated. This widget will be removed in GTK 5
AssistantPage	getPage(Widget child)	Deprecated. This widget will be removed in GTK 5
boolean	getPageComplete(Widget page)	Deprecated. This widget will be removed in GTK 5
ListModel	getPages()	Deprecated. This widget will be removed in GTK 5
String	getPageTitle(Widget page)	Deprecated. This widget will be removed in GTK 5
AssistantPageType	getPageType(Widget page)	Deprecated. This widget will be removed in GTK 5
static @Nullable Type	getType()	Deprecated. Get the GType of the Assistant class
int	insertPage(Widget page, int position)	Deprecated. This widget will be removed in GTK 5
void	nextPage()	Deprecated. This widget will be removed in GTK 5
SignalConnection<Assistant.ApplyCallback>	onApply(Assistant.ApplyCallback handler)	Deprecated. This widget will be removed in GTK 5
SignalConnection<Assistant.CancelCallback>	onCancel(Assistant.CancelCallback handler)	Deprecated. This widget will be removed in GTK 5
SignalConnection<Assistant.CloseCallback>	onClose(Assistant.CloseCallback handler)	Deprecated. This widget will be removed in GTK 5
SignalConnection<Assistant.EscapeCallback>	onEscape(Assistant.EscapeCallback handler)	Deprecated. This widget will be removed in GTK 5
SignalConnection<Assistant.PrepareCallback>	onPrepare(Assistant.PrepareCallback handler)	Deprecated. This widget will be removed in GTK 5
int	prependPage(Widget page)	Deprecated. This widget will be removed in GTK 5
void	previousPage()	Deprecated. This widget will be removed in GTK 5
void	removeActionWidget(Widget child)	Deprecated. This widget will be removed in GTK 5
void	removePage(int pageNum)	Deprecated. This widget will be removed in GTK 5
void	setCurrentPage(int pageNum)	Deprecated. This widget will be removed in GTK 5
void	setForwardPageFunc(@Nullable AssistantPageFunc pageFunc)	Deprecated. This widget will be removed in GTK 5
void	setPageComplete(Widget page, boolean complete)	Deprecated. This widget will be removed in GTK 5
void	setPageTitle(Widget page, String title)	Deprecated. This widget will be removed in GTK 5
void	setPageType(Widget page, AssistantPageType type)	Deprecated. This widget will be removed in GTK 5
void	updateButtonsState()	Deprecated. This widget will be removed in GTK 5

Methods inherited from class org.gnome.gtk.Window

activateDefault, activateFocus, close, closeRequest, destroy, emitActivateDefault, emitActivateFocus, emitCloseRequest, emitEnableDebugging, emitKeysChanged, enableDebugging, fullscreen, fullscreenOnMonitor, getApplication, getChild, getDecorated, getDefaultIconName, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getFocus, getFocusVisible, getGravity, getGroup, getHandleMenubarAccel, getHideOnClose, getIconName, getMemoryLayout, getMnemonicsVisible, getModal, getResizable, getTitle, getTitlebar, getToplevels, getTransientFor, hasGroup, isActive, isFullscreen, isMaximized, isSuspended, keysChanged, listToplevels, maximize, minimize, onActivateDefault, onActivateFocus, onCloseRequest, onEnableDebugging, onKeysChanged, present, presentWithTime, setApplication, setAutoStartupNotification, setChild, setDecorated, setDefaultIconName, setDefaultSize, setDefaultWidget, setDeletable, setDestroyWithParent, setDisplay, setFocus, setFocusVisible, setGravity, setHandleMenubarAccel, setHideOnClose, setIconName, setInteractiveDebugging, setMnemonicsVisible, setModal, setResizable, setStartupId, setTitle, setTitlebar, setTransientFor, unfullscreen, unmaximize, unminimize

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.gnome.gtk.Native

getRenderer, getSurface, getSurfaceTransform, realize, unrealize

Methods inherited from interface org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.Root

getDisplay, getFocus, setFocus

Constructor Details

Assistant

public Assistant(MemorySegment address)

Deprecated.

Create a Assistant proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Assistant

public Assistant()

Deprecated.

Creates a new Assistant.

Method Details

getType

public static @Nullable Type getType()

Deprecated.

Get the GType of the Assistant class

Returns:

the GType

asParent

protected Assistant asParent()

Deprecated.

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Window

addActionWidget

@Deprecated
public void addActionWidget(Widget child)

Deprecated.

This widget will be removed in GTK 5

Adds a widget to the action area of a GtkAssistant.

Parameters:

child - a GtkWidget

appendPage

@Deprecated
public int appendPage(Widget page)

Deprecated.

This widget will be removed in GTK 5

Appends a page to the assistant.

Parameters:

page - a GtkWidget

Returns:

the index (starting at 0) of the inserted page

commit

@Deprecated
public void commit()

Deprecated.

This widget will be removed in GTK 5

Erases the visited page history.

GTK will then hide the back button on the current page, and removes the cancel button from subsequent pages.

Use this when the information provided up to the current page is hereafter deemed permanent and cannot be modified or undone. For example, showing a progress page to track a long-running, unreversible operation after the user has clicked apply on a confirmation page.

getCurrentPage

@Deprecated
public int getCurrentPage()

Deprecated.

This widget will be removed in GTK 5

Returns the page number of the current page.

Returns:

The index (starting from 0) of the current page in the assistant, or -1 if the this Assistant has no pages, or no current page

getNPages

@Deprecated
public int getNPages()

Deprecated.

This widget will be removed in GTK 5

Returns the number of pages in the this Assistant

Returns:

the number of pages in the this Assistant

getNthPage

@Deprecated
public @Nullable Widget getNthPage(int pageNum)

Deprecated.

This widget will be removed in GTK 5

Returns the child widget contained in page number pageNum.

Parameters:

pageNum - the index of a page in the assistant, or -1 to get the last page

Returns:

the child widget, or null if pageNum is out of bounds

getPage

@Deprecated
public AssistantPage getPage(Widget child)

Deprecated.

This widget will be removed in GTK 5

Returns the GtkAssistantPage object for child.

Parameters:

child - a child of this Assistant

Returns:

the GtkAssistantPage for child

getPageComplete

@Deprecated
public boolean getPageComplete(Widget page)

Deprecated.

This widget will be removed in GTK 5

Gets whether page is complete.

Parameters:

page - a page of this Assistant

Returns:

true if page is complete.

getPageTitle

@Deprecated
public String getPageTitle(Widget page)

Deprecated.

This widget will be removed in GTK 5

Gets the title for page.

Parameters:

page - a page of this Assistant

Returns:

the title for page

getPageType

@Deprecated
public AssistantPageType getPageType(Widget page)

Deprecated.

This widget will be removed in GTK 5

Gets the page type of page.

Parameters:

page - a page of this Assistant

Returns:

the page type of page

getPages

@Deprecated
public ListModel getPages()

Deprecated.

This widget will be removed in GTK 5

Gets a list model of the assistant pages.

Returns:

A list model of the pages.

insertPage

@Deprecated
public int insertPage(Widget page,
 int position)

Deprecated.

This widget will be removed in GTK 5

Inserts a page in the this Assistant at a given position.

Parameters:

page - a GtkWidget

position - the index (starting at 0) at which to insert the page, or -1 to append the page to the this Assistant

Returns:

the index (starting from 0) of the inserted page

nextPage

@Deprecated
public void nextPage()

Deprecated.

This widget will be removed in GTK 5

Navigate to the next page.

It is a programming error to call this function when there is no next page.

This function is for use when creating pages of the AssistantPageType.CUSTOM type.

prependPage

@Deprecated
public int prependPage(Widget page)

Deprecated.

This widget will be removed in GTK 5

Prepends a page to the assistant.

Parameters:

page - a GtkWidget

Returns:

the index (starting at 0) of the inserted page

previousPage

@Deprecated
public void previousPage()

Deprecated.

This widget will be removed in GTK 5

Navigate to the previous visited page.

It is a programming error to call this function when no previous page is available.

This function is for use when creating pages of the AssistantPageType.CUSTOM type.

removeActionWidget

@Deprecated
public void removeActionWidget(Widget child)

Deprecated.

This widget will be removed in GTK 5

Removes a widget from the action area of a GtkAssistant.

Parameters:

child - a GtkWidget

removePage

@Deprecated
public void removePage(int pageNum)

Deprecated.

This widget will be removed in GTK 5

Removes the pageNum’s page from assistant.

Parameters:

pageNum - the index of a page in the assistant, or -1 to remove the last page

setCurrentPage

@Deprecated
public void setCurrentPage(int pageNum)

Deprecated.

This widget will be removed in GTK 5

Switches the page to pageNum.

Note that this will only be necessary in custom buttons, as the this Assistant flow can be set with gtk_assistant_set_forward_page_func().

Parameters:

pageNum - index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the assistant, nothing will be done.

setForwardPageFunc

@Deprecated
public void setForwardPageFunc(@Nullable AssistantPageFunc pageFunc)

Deprecated.

This widget will be removed in GTK 5

Sets the page forwarding function to be pageFunc.

This function will be used to determine what will be the next page when the user presses the forward button. Setting pageFunc to null will make the assistant to use the default forward function, which just goes to the next visible page.

Parameters:

pageFunc - the GtkAssistantPageFunc, or null to use the default one

setPageComplete

@Deprecated
public void setPageComplete(Widget page,
 boolean complete)

Deprecated.

This widget will be removed in GTK 5

Sets whether page contents are complete.

This will make this Assistant update the buttons state to be able to continue the task.

Parameters:

page - a page of this Assistant

complete - the completeness status of the page

setPageTitle

@Deprecated
public void setPageTitle(Widget page,
 String title)

Deprecated.

This widget will be removed in GTK 5

Sets a title for page.

The title is displayed in the header area of the assistant when page is the current page.

Parameters:

page - a page of this Assistant

title - the new title for page

setPageType

@Deprecated
public void setPageType(Widget page,
 AssistantPageType type)

Deprecated.

This widget will be removed in GTK 5

Sets the page type for page.

The page type determines the page behavior in the assistant.

Parameters:

page - a page of this Assistant

type - the new type for page

updateButtonsState

@Deprecated
public void updateButtonsState()

Deprecated.

This widget will be removed in GTK 5

Forces this Assistant to recompute the buttons state.

GTK automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.

One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.

onApply

@Deprecated
public SignalConnection<Assistant.ApplyCallback> onApply(Assistant.ApplyCallback handler)

Deprecated.

This widget will be removed in GTK 5

Emitted when the apply button is clicked.

The default behavior of the GtkAssistant is to switch to the page after the current page, unless the current page is the last one.

A handler for the ::apply signal should carry out the actions for which the wizard has collected data. If the action takes a long time to complete, you might consider putting a page of type AssistantPageType.PROGRESS after the confirmation page and handle this operation within the Gtk.Assistant::prepare signal of the progress page.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Assistant.ApplyCallback.run()

emitApply

@Deprecated
public void emitApply()

Deprecated.

Emits the "apply" signal. See onApply(org.gnome.gtk.Assistant.ApplyCallback).

onCancel

@Deprecated
public SignalConnection<Assistant.CancelCallback> onCancel(Assistant.CancelCallback handler)

Deprecated.

This widget will be removed in GTK 5

Emitted when then the cancel button is clicked.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Assistant.CancelCallback.run()

emitCancel

@Deprecated
public void emitCancel()

Deprecated.

Emits the "cancel" signal. See onCancel(org.gnome.gtk.Assistant.CancelCallback).

onClose

@Deprecated
public SignalConnection<Assistant.CloseCallback> onClose(Assistant.CloseCallback handler)

Deprecated.

This widget will be removed in GTK 5

Emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type AssistantPageType.CONFIRM) is clicked.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Assistant.CloseCallback.run()

emitClose

@Deprecated
public void emitClose()

Deprecated.

Emits the "close" signal. See onClose(org.gnome.gtk.Assistant.CloseCallback).

onEscape

@Deprecated
public SignalConnection<Assistant.EscapeCallback> onEscape(Assistant.EscapeCallback handler)

Deprecated.

This widget will be removed in GTK 5

The action signal for the Escape binding.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Assistant.EscapeCallback.run()

emitEscape

@Deprecated
public void emitEscape()

Deprecated.

Emits the "escape" signal. See onEscape(org.gnome.gtk.Assistant.EscapeCallback).

onPrepare

@Deprecated
public SignalConnection<Assistant.PrepareCallback> onPrepare(Assistant.PrepareCallback handler)

Deprecated.

This widget will be removed in GTK 5

Emitted when a new page is set as the assistant's current page, before making the new page visible.

A handler for this signal can do any preparations which are necessary before showing page.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Assistant.PrepareCallback.run(org.gnome.gtk.Widget)

emitPrepare

@Deprecated
public void emitPrepare(@Nullable Widget page)

Deprecated.

Emits the "prepare" signal. See onPrepare(org.gnome.gtk.Assistant.PrepareCallback).

builder

public static Assistant.Builder<? extends Assistant.Builder> builder()

Deprecated.

A Assistant.Builder object constructs a Assistant with the specified properties. Use the various set...() methods to set properties, and finish construction with Assistant.Builder.build().

Returns:

the builder object