GuidanceStylist.Guidance

class GuidanceStylist.Guidance

A data class representing contextual information for a . Guidance consists of a short title, a longer description, a breadcrumb to help with global navigation (often indicating where the back button will lead), and an optional icon. All this information is intended to provide users with the appropriate context to make the decision(s) required by the current step.

Clients may provide a subclass of this if they wish to remember auxiliary data for use in a customized GuidanceStylist.

Summary

Public constructors
Guidance(
    title: String?,
    description: String?,
    breadcrumb: String?,
    icon: Drawable?
)

Constructs a Guidance object with the specified title, description, breadcrumb, and icon drawable.

Public functions
String?

Returns the breadcrumb specified when this Guidance was constructed.
String?

Returns the description specified when this Guidance was constructed.
Drawable?

Returns the icon drawable specified when this Guidance was constructed.
String?

Returns the title specified when this Guidance was constructed.

Public constructors

Guidance

Added in 1.1.0
Guidance(
    title: String?,
    description: String?,
    breadcrumb: String?,
    icon: Drawable?
)

Constructs a Guidance object with the specified title, description, breadcrumb, and icon drawable.

Parameters
title: String?

The title for the current guided step.
description: String?

The description for the current guided step.
breadcrumb: String?

The breadcrumb for the current guided step.
icon: Drawable?

The icon drawable representing the current guided step.

Public functions

getBreadcrumb

Added in 1.1.0
fun getBreadcrumb(): String?

Returns the breadcrumb specified when this Guidance was constructed.

Returns
String?

The breadcrumb for this Guidance.

getDescription

Added in 1.1.0
fun getDescription(): String?

Returns the description specified when this Guidance was constructed.

Returns
String?

The description for this Guidance.

getIconDrawable

Added in 1.1.0
fun getIconDrawable(): Drawable?

Returns the icon drawable specified when this Guidance was constructed.

Returns
Drawable?

The icon for this Guidance.

getTitle

Added in 1.1.0
fun getTitle(): String?

Returns the title specified when this Guidance was constructed.

Returns
String?

The title for this Guidance.