IGlobalDialog interface

Package:

azure-devops-extension-api

Dialog Props specifying how it will be rendered by the service

Properties

buttonProps	Props to pass to buttons in the footer.
closeButtonProps	Props to pass to the close button.
contentProperties	Props (type: ICustomDialogProps) to pass to the custom contribution.
contributionConfiguration	Optional initial configuration for the contributed content. Used in pair with contributionId.
contributionId	The id of the custom contribution to host in the dialog. Used to render a customized dialog.
message	The text of the dialog message. Ignored if contributionId is specified.
messageFormat	The format to use to replace links within the message.
messageLinks	Links to be formatted into the message.
onDismiss	Method that is called when the dialog is dismissed.
priority	The priority of the dialog determines if it will be shown over others.
settingId	The id used to check if the dialog has been dismissed.
title	The title of the dialog.

Property Details

buttonProps

Props to pass to buttons in the footer.

buttonProps?: Object[]

Property Value

Object[]

closeButtonProps

Props to pass to the close button.

closeButtonProps?: Object

Property Value

Object

contentProperties

Props (type: ICustomDialogProps) to pass to the custom contribution.

contentProperties?: Object

Property Value

Object

contributionConfiguration

Optional initial configuration for the contributed content. Used in pair with contributionId.

contributionConfiguration?: Object

Property Value

Object

contributionId

The id of the custom contribution to host in the dialog. Used to render a customized dialog.

contributionId?: string

Property Value

string

message

The text of the dialog message. Ignored if contributionId is specified.

message?: string

Property Value

string

messageFormat

The format to use to replace links within the message.

messageFormat?: string

Property Value

string

messageLinks

Links to be formatted into the message.

messageLinks?: IGlobalMessageLink[]

Property Value

IGlobalMessageLink[]

onDismiss

Method that is called when the dialog is dismissed.

onDismiss?: () => void

Property Value

() => void

priority

The priority of the dialog determines if it will be shown over others.

priority?: number

Property Value

number

settingId

The id used to check if the dialog has been dismissed.

settingId?: string

Property Value

string

title

The title of the dialog.

title?: string

Property Value

string