GuidedAction

const val ACTION_ID_CANCEL = -5: Long

Id of standard Cancel action.

const val ACTION_ID_CONTINUE = -7: Long

Id of standard Finish action.

const val ACTION_ID_CURRENT = -3: Long

When finishing editing, stay on current action.

const val ACTION_ID_FINISH = -6: Long

Id of standard Finish action.

const val ACTION_ID_NEXT = -2: Long

When finishing editing, goes to next action.

const val ACTION_ID_NO = -9: Long

Id of standard No action.

const val ACTION_ID_OK = -4: Long

Id of standard OK action.

const val ACTION_ID_YES = -8: Long

Id of standard Yes action.

const val CHECKBOX_CHECK_SET_ID = -1: Int

Checkset Id for checkbox.

const val DEFAULT_CHECK_SET_ID = 1: Int

Default checkset Id for radio.

const val NO_CHECK_SET = 0: Int

Special check set Id that is neither checkbox nor radio.

fun getAutofillHints(): Array<String!>!

Returns autofill hints, see setAutofillHints.

fun getCheckSetId(): Int

Returns the check set id this action is a part of. All actions in the same list with the same check set id are considered linked. When one of the actions within that set is selected, that action becomes checked, while all the other actions become unchecked.

fun getDescription(): CharSequence?

Returns the description of this action.

fun getDescriptionEditInputType(): Int

Returns InputType of action description in editing; only valid when isDescriptionEditable is true.

fun getDescriptionInputType(): Int

Returns InputType of action description not in editing.

fun getEditDescription(): CharSequence?

Returns the optional description text to edit. When not null, it is being edited instead of getDescription.

fun getEditInputType(): Int

Returns InputType of action title in editing; only valid when isEditable is true.

fun getEditTitle(): CharSequence?

Returns the optional title text to edit. When not null, it is being edited instead of getTitle.

fun getInputType(): Int

Returns InputType of action title not in editing.

fun getIntent(): Intent?

Returns the intent associated with this action.

fun getTitle(): CharSequence?

Returns the title of this action.

fun hasEditableActivatorView(): Boolean

Returns whether this action can be activated to edit, e.g. a DatePicker.

fun hasMultilineDescription(): Boolean

Returns whether this action is has a multiline description.

fun hasNext(): Boolean

Returns whether this action will request further user input when selected, such as showing another GuidedStepFragment or launching a new activity. Configured during construction.

fun hasTextEditable(): Boolean

Returns if this action has editable title or editable description.

fun infoOnly(): Boolean

Returns whether the action will only display information and is thus not clickable. If both this and hasNext are true, infoOnly takes precedence. The default is false. For example, this might represent e.g. the amount of storage a document uses, or the cost of an app.

fun isAutoSaveRestoreEnabled(): Boolean

Returns true if Action will be saved to instanceState and restored later, false otherwise. The default value is true. When isAutoSaveRestoreEnabled() is true and getId is not NO_ID:

• isEditable is true: save text of getTitle
• isDescriptionEditable is true: save text of getDescription
• getCheckSetId is not NO_CHECK_SET: save isChecked}
• GuidedDatePickerAction will be saved

fun isChecked(): Boolean

Returns whether this action is checked.

fun isDescriptionEditable(): Boolean

Returns whether this action description is editable.

fun isEditTitleUsed(): Boolean

Returns true if getEditTitle is not null. When true, the getEditTitle is being edited instead of getTitle.

fun isEditable(): Boolean

Returns whether this action title is editable.

fun isEnabled(): Boolean

Returns whether this action is enabled.

fun isFocusable(): Boolean

Returns whether this action is focusable.

fun onRestoreInstanceState(bundle: Bundle, key: String): Unit

Restore action from a bundle using a given key. When isAutoRestore() is true:

• isEditable is true: save text of getTitle
• isDescriptionEditable is true: save text of getDescription
• getCheckSetId is not NO_CHECK_SET: save isChecked}
• GuidedDatePickerAction will be saved

fun onSaveInstanceState(bundle: Bundle, key: String): Unit

Save action into a bundle using a given key. When isAutoRestoreEna() is true:

• isEditable is true: save text of getTitle
• isDescriptionEditable is true: save text of getDescription
• getCheckSetId is not NO_CHECK_SET: save isChecked}
• GuidedDatePickerAction will be saved

fun setChecked(checked: Boolean): Unit

Sets whether this action is checked.

fun setDescription(description: CharSequence?): Unit

Sets the description of this action.

fun setEditDescription(editDescription: CharSequence?): Unit

Sets the optional description text to edit instead of setDescription.

fun setEditTitle(editTitle: CharSequence?): Unit

Sets the optional title text to edit instead of setTitle.

fun setEnabled(enabled: Boolean): Unit

Sets whether this action is enabled.

fun setFocusable(focusable: Boolean): Unit

Sets whether this action is focusable.

fun setIntent(intent: Intent?): Unit

Sets the intent of this action.

fun setSubActions(actions: (Mutable)List<GuidedAction!>?): Unit

Change sub actions list.

fun setTitle(title: CharSequence?): Unit

Sets the title of this action.