Partager via


azure-devops-extension-sdk package

Interfaces

ContextIdentifier
GlobalizationContext
IExtensionContext

Identificateur de l’extension actuelle

IExtensionInitOptions

Options d’initialisation d’extension -- transmises à DevOps.init()

IHostContext

Informations sur l’hôte DevOps actuel (organisation)

IPageContext

Contexte global placé sur chaque page web

ITeamContext

Informations sur l’équipe DevOps actuelle

IUserContext

Informations sur l’utilisateur actuel

Énumérations

HostType

Niveau d’hôte DevOps

Functions

applyTheme({[varName: string]: string})

Applique des variables de thème au document actif

getAccessToken()

Récupérer un jeton d’accès qui permettra d’effectuer des appels à d’autres services DevOps

getAppToken()

Récupérer un jeton qui peut être utilisé pour identifier l’utilisateur actuel

getConfiguration()

Obtenir les données de configuration transmises dans l’établissement d’une liaison initiale à partir de l’image parente

getContributionId()

Obtient les informations sur la contribution qui a d’abord provoqué le chargement de cette extension.

getExtensionContext()

Obtenir le contexte sur l’extension qui possède le contenu hébergé

getHost()

Obtient des informations sur l’hôte (c’est-à-dire une organisation Azure DevOps) que la page cible

getPageContext()

Obtenir le contexte sur la page hôte

getService<T>(string)

Obtenez la contribution avec l’ID de contribution donné. La contribution retournée a une méthode permettant d’obtenir un objet inscrit dans cette contribution.

getTeamContext()

Obtient des informations sur l’équipe que la page cible

getUser()

Obtient des informations sur l’utilisateur actuel

getWebContext()

Obtenir le contexte sur le web

init(IExtensionInitOptions)

Lance l’établissement d’une liaison avec la fenêtre hôte.

notifyLoadFailed(string | Error)

Avertit l’hôte que l’extension n’a pas pu être chargée

notifyLoadSucceeded()

Avertit l’hôte que l’extension a été correctement chargée (arrêtant l’indicateur de chargement)

ready()

Inscrivez un rappel qui est appelé une fois la négociation/configuration initiale terminée. Si la configuration initiale est déjà terminée, le rappel est appelé à la fin de la pile des appels actuelle.

register<T>(string, T)

Inscrivez un objet (instance ou méthode de fabrique) que cette extension expose au frame hôte.

resize(number, number)

Demande à la fenêtre parente de redimensionner le conteneur pour cette extension en fonction de la taille actuelle de l’extension.

unregister(string)

Supprime un objet exposé à l’image hôte par cette extension.

Informations relatives à la fonction

applyTheme({[varName: string]: string})

Applique des variables de thème au document actif

function applyTheme(themeData: {[varName: string]: string})

Paramètres

themeData

{[varName: string]: string}

getAccessToken()

Récupérer un jeton d’accès qui permettra d’effectuer des appels à d’autres services DevOps

function getAccessToken(): Promise<string>

Retours

Promise<string>

getAppToken()

Récupérer un jeton qui peut être utilisé pour identifier l’utilisateur actuel

function getAppToken(): Promise<string>

Retours

Promise<string>

getConfiguration()

Obtenir les données de configuration transmises dans l’établissement d’une liaison initiale à partir de l’image parente

function getConfiguration(): {[key: string]: any}

Retours

{[key: string]: any}

getContributionId()

Obtient les informations sur la contribution qui a d’abord provoqué le chargement de cette extension.

function getContributionId(): string

Retours

string

getExtensionContext()

Obtenir le contexte sur l’extension qui possède le contenu hébergé

function getExtensionContext(): IExtensionContext

Retours

getHost()

Obtient des informations sur l’hôte (c’est-à-dire une organisation Azure DevOps) que la page cible

function getHost(): IHostContext

Retours

getPageContext()

Obtenir le contexte sur la page hôte

function getPageContext(): IPageContext

Retours

getService<T>(string)

Obtenez la contribution avec l’ID de contribution donné. La contribution retournée a une méthode permettant d’obtenir un objet inscrit dans cette contribution.

function getService<T>(contributionId: string): Promise<T>

Paramètres

contributionId

string

ID de la contribution à obtenir

Retours

Promise<T>

getTeamContext()

Obtient des informations sur l’équipe que la page cible

function getTeamContext(): ITeamContext

Retours

getUser()

Obtient des informations sur l’utilisateur actuel

function getUser(): IUserContext

Retours

getWebContext()

Obtenir le contexte sur le web

function getWebContext(): IWebContext

Retours

IWebContext

init(IExtensionInitOptions)

Lance l’établissement d’une liaison avec la fenêtre hôte.

function init(options?: IExtensionInitOptions): Promise<void>

Paramètres

options
IExtensionInitOptions

Options d’initialisation de l’extension.

Retours

Promise<void>

notifyLoadFailed(string | Error)

Avertit l’hôte que l’extension n’a pas pu être chargée

function notifyLoadFailed(e: string | Error): Promise<void>

Paramètres

e

string | Error

Retours

Promise<void>

notifyLoadSucceeded()

Avertit l’hôte que l’extension a été correctement chargée (arrêtant l’indicateur de chargement)

function notifyLoadSucceeded(): Promise<void>

Retours

Promise<void>

ready()

Inscrivez un rappel qui est appelé une fois la négociation/configuration initiale terminée. Si la configuration initiale est déjà terminée, le rappel est appelé à la fin de la pile des appels actuelle.

function ready(): Promise<void>

Retours

Promise<void>

register<T>(string, T)

Inscrivez un objet (instance ou méthode de fabrique) que cette extension expose au frame hôte.

function register<T>(instanceId: string, instance: T)

Paramètres

instanceId

string

ID unique de l’objet inscrit

instance

T

Soit : (1) une instance d’objet, soit (2) une fonction qui accepte des données de contexte facultatives et retourne une instance d’objet.

resize(number, number)

Demande à la fenêtre parente de redimensionner le conteneur pour cette extension en fonction de la taille actuelle de l’extension.

function resize(width?: number, height?: number)

Paramètres

width

number

Largeur facultative, valeurs par défaut pour scrollWidth

height

number

Hauteur facultative, valeur par défaut pour scrollHeight

unregister(string)

Supprime un objet exposé à l’image hôte par cette extension.

function unregister(instanceId: string)

Paramètres

instanceId

string

ID unique de l’objet inscrit