IGlobalMessageBanner interface

Banner Props specifying how it will be rendered by the service

Properties

buttons

Buttons to display after the message

customIcon

Custom icon name. Must be an icon in the Azure DevOps icon font.

dismissable

Whether or not the message banner is dismissable. If false, do not show the close (X) icon.

helpInfo

Optional "?" icon to show after the message that has a tooltip with more information and/or a hyperlink.

level

banner level (controls the background and icon of the banner)

message

Banner message. Ignored if messageFormat is also provided

messageFormat

Banner message format string. Arguments (like {0}, {1} are filled in with hyperlinks supplied in messageLinks)

messageLinks

Links to supply to the format arguments in messageFormat

Property Details

buttons

Buttons to display after the message

buttons?: IContributedButton[]

Property Value

customIcon

Custom icon name. Must be an icon in the Azure DevOps icon font.

customIcon?: string

Property Value

string

dismissable

Whether or not the message banner is dismissable. If false, do not show the close (X) icon.

dismissable?: boolean

Property Value

boolean

helpInfo

Optional "?" icon to show after the message that has a tooltip with more information and/or a hyperlink.

helpInfo?: IGlobalMessageHelpInfo

Property Value

level

banner level (controls the background and icon of the banner)

level?: MessageBannerLevel

Property Value

message

Banner message. Ignored if messageFormat is also provided

message?: string

Property Value

string

messageFormat

Banner message format string. Arguments (like {0}, {1} are filled in with hyperlinks supplied in messageLinks)

messageFormat?: string

Property Value

string

Links to supply to the format arguments in messageFormat

messageLinks?: IGlobalMessageLink[]

Property Value