Toast

Kotlin |Java

open class Toast

kotlin.Any
↳	android.widget.Toast

A toast is a view containing a quick little message for the user. The toast class helps you create and show those. {@more}

When the view is shown to the user, appears as a floating view over the application. It will never receive focus. The user will probably be in the middle of typing something else. The idea is to be as unobtrusive as possible, while still showing the user the information you want them to see. Two examples are the volume control, and the brief message saying that your settings have been saved.

The easiest way to use this class is to call one of the static methods that constructs everything you need and returns a new Toast object.

Note that Snackbars are preferred for brief messages while the app is in the foreground.

Note that toasts being sent from the background are rate limited, so avoid sending such toasts in quick succession.

Starting with Android 12 (API level 31), apps targeting Android 12 or newer will have their toasts limited to two lines.

Summary

Nested classes
abstract	`Callback` Callback object to be called when the toast is shown or hidden.

Constants
static Int	`LENGTH_LONG` Show the view or text notification for a long period of time.
static Int	`LENGTH_SHORT` Show the view or text notification for a short period of time.

Public constructors
`Toast(context: Context!)` Construct an empty Toast object.

Public methods
open Unit	`addCallback(callback: Toast.Callback)` Adds a callback to be notified when the toast is shown or hidden.
open Unit	`cancel()` Close the view if it's showing, or don't show it if it isn't showing yet.
open Int	`getDuration()` Return the duration.
open Int	`getGravity()` Get the location at which the notification should appear on the screen.
open Float	`getHorizontalMargin()` Return the horizontal margin.
open Float	`getVerticalMargin()` Return the vertical margin.
open View?	`getView()` Return the view.
open Int	`getXOffset()` Return the X offset in pixels to apply to the gravity's location.
open Int	`getYOffset()` Return the Y offset in pixels to apply to the gravity's location.
open static Toast!	`makeText(context: Context!, text: CharSequence!, duration: Int)` Make a standard toast that just contains text.
open static Toast!	`makeText(context: Context!, resId: Int, duration: Int)` Make a standard toast that just contains text from a resource.
open Unit	`removeCallback(callback: Toast.Callback)` Removes a callback previously added with `addCallback(android.widget.Toast.Callback)`.
open Unit	`setDuration(duration: Int)` Set how long to show the view for.
open Unit	`setGravity(gravity: Int, xOffset: Int, yOffset: Int)` Set the location at which the notification should appear on the screen.
open Unit	`setMargin(horizontalMargin: Float, verticalMargin: Float)` Set the margins of the view.
open Unit	`setText(resId: Int)` Update the text in a Toast that was previously created using one of the makeText() methods.
open Unit	`setText(s: CharSequence!)` Update the text in a Toast that was previously created using one of the makeText() methods.
open Unit	`setView(view: View!)` Set the view to show.
open Unit	`show()` Show the view for the specified duration.

Parameters
`context`	Context!: The context to use. Usually your `android.app.Activity` object.
`text`	CharSequence!: The text to show. Can be formatted text.
`duration`	Int: How long to display the message. Either `LENGTH_SHORT` or `LENGTH_LONG` Value is `android.widget.Toast#LENGTH_SHORT`, or `android.widget.Toast#LENGTH_LONG`

Parameters
`context`	Context!: The context to use. Usually your `android.app.Activity` object.
`resId`	Int: The resource id of the string resource to use. Can be formatted text.
`duration`	Int: How long to display the message. Either `LENGTH_SHORT` or `LENGTH_LONG` Value is `android.widget.Toast#LENGTH_SHORT`, or `android.widget.Toast#LENGTH_LONG`

Parameters
`horizontalMargin`	Float: The horizontal margin, in percentage of the container width, between the container's edges and the notification
`verticalMargin`	Float: The vertical margin, in percentage of the container height, between the container's edges and the notification

Toast

Summary

Constants

LENGTH_LONG

LENGTH_SHORT

Public constructors

Toast

Public methods

addCallback

cancel

getDuration

getGravity

getHorizontalMargin

getVerticalMargin

getView

getXOffset

getYOffset

makeText

makeText

removeCallback

setDuration

setGravity

setMargin

setText

setText

setView

show