IToast interface

Package:

azure-devops-extension-api

Toast Props with metadata to specify how it will be rendered by the service

Properties

callToAction	Optional text for the Call to Action
duration	Duration in ms the toast will appear for
forceOverrideExisting	If true, we'll immediately take down any existing toast and display this instead Otherwise, it adds it to an internal queue in the GlobalToast and will display after others in the queue
message	Message to display on the Toast
onCallToActionClick	Optional handler for when the Call to Action is clicked

Property Details

callToAction

Optional text for the Call to Action

callToAction?: string

Property Value

string

duration

Duration in ms the toast will appear for

duration: number

Property Value

number

forceOverrideExisting

If true, we'll immediately take down any existing toast and display this instead Otherwise, it adds it to an internal queue in the GlobalToast and will display after others in the queue

forceOverrideExisting?: boolean

Property Value

boolean

message

Message to display on the Toast

message: string

Property Value

string

onCallToActionClick

Optional handler for when the Call to Action is clicked

onCallToActionClick?: () => void

Property Value

() => void