GuidanceStylist.Guidance

Added in 1.1.0

Kotlin |Java

public 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( @Nullable String title, @Nullable String description, @Nullable String breadcrumb, @Nullable Drawable icon )` Constructs a Guidance object with the specified title, description, breadcrumb, and icon drawable.

Public methods
`@Nullable String`	`getBreadcrumb()` Returns the breadcrumb specified when this Guidance was constructed.
`@Nullable String`	`getDescription()` Returns the description specified when this Guidance was constructed.
`@Nullable Drawable`	`getIconDrawable()` Returns the icon drawable specified when this Guidance was constructed.
`@Nullable String`	`getTitle()` Returns the title specified when this Guidance was constructed.

Public constructors

Guidance

Added in 1.1.0

public Guidance(
    @Nullable String title,
    @Nullable String description,
    @Nullable String breadcrumb,
    @Nullable Drawable icon
)

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

Parameters
`@Nullable String title`	The title for the current guided step.
`@Nullable String description`	The description for the current guided step.
`@Nullable String breadcrumb`	The breadcrumb for the current guided step.
`@Nullable Drawable icon`	The icon drawable representing the current guided step.

Public methods

getBreadcrumb

Added in 1.1.0

public @Nullable String getBreadcrumb()

Returns the breadcrumb specified when this Guidance was constructed.

Returns
`@Nullable String`	The breadcrumb for this Guidance.

getDescription

Added in 1.1.0

public @Nullable String getDescription()

Returns the description specified when this Guidance was constructed.

Returns
`@Nullable String`	The description for this Guidance.

getIconDrawable

Added in 1.1.0

public @Nullable Drawable getIconDrawable()

Returns the icon drawable specified when this Guidance was constructed.

Returns
`@Nullable Drawable`	The icon for this Guidance.

getTitle

Added in 1.1.0

public @Nullable String getTitle()

Returns the title specified when this Guidance was constructed.

Returns
`@Nullable String`	The title for this Guidance.