azure-devops-extension-sdk package
Classes
XDMChannel |
Représente un canal de communication entre frames\document Reste « actif » sur plusieurs appels de funtion\méthode |
XDMObjectRegistry |
Catalogue d’objets exposés pour XDM |
Interfaces
ContextIdentifier | |
GlobalizationContext | |
IExtensionContext |
Identificateur de l’extension actuelle |
IExtensionInitOptions |
Options pour l’initialisation de l’extension - passées à DevOps.init() |
IHostContext |
Informations sur l’hôte DevOps actuel (organization) |
IPageContext |
Contexte global placé sur chaque page web |
ITeamContext |
Informations sur l’équipe DevOps actuelle |
IUserContext |
Informations sur l’utilisateur actuel |
IJsonRpcMessage |
Représente un appel de procédure distante (rpc) entre des images. |
ISerializationSettings |
Paramètres liés à la sérialisation des données au-delà des limites de l’iframe. |
IXDMChannel |
Interface pour un seul canal XDM |
IXDMChannelManager |
Registre des canaux XDM conservés par frame/fenêtre cible |
IXDMObjectRegistry |
Registre des objets XDM qui peuvent être appelés par un canal XDM |
Énumérations
HostType |
Niveau de l’hôte DevOps |
Fonctions
apply |
Applique des variables de thème au document actif |
get |
Récupérer un jeton d’accès qui permettra d’effectuer des appels à d’autres services DevOps |
get |
Récupérer un jeton qui peut être utilisé pour identifier l’utilisateur actuel |
get |
Obtenir les données de configuration passées dans la négociation initiale à partir du frame parent |
get |
Obtient les informations sur la contribution à l’origine du chargement de cette extension. |
get |
Obtenir le contexte de l’extension qui possède le contenu hébergé |
get |
Obtient des informations sur l’hôte (c’est-à-dire un organization Azure DevOps) que la page cible |
get |
Obtenir le contexte de la page hôte |
get |
Obtenez la contribution avec l’ID de contribution donné. La contribution retournée a une méthode pour obtenir un objet inscrit dans cette contribution. |
get |
Obtient des informations sur l’équipe ciblée par la page |
get |
Obtient des informations sur l’utilisateur actuel |
get |
Obtenir le contexte sur le web |
init(IExtension |
Lance l’établissement d’une liaison avec la fenêtre hôte. |
notify |
Avertit l’hôte que l’extension n’a pas pu être chargée |
notify |
Avertit l’hôte que l’extension a été correctement chargée (arrêter d’afficher l’indicateur de chargement) |
ready() | Inscrivez un rappel qui est appelé une fois l’installation/la négociation initiale terminée. Si l’installation 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 d’extension actuelle. |
unregister(string) | Supprime un objet que cette extension a exposé au frame hôte. |
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 passées dans la négociation initiale à partir du frame parent
function getConfiguration(): {[key: string]: any}
Retours
{[key: string]: any}
getContributionId()
Obtient les informations sur la contribution à l’origine du chargement de cette extension.
function getContributionId(): string
Retours
string
getExtensionContext()
Obtenir le contexte de l’extension qui possède le contenu hébergé
function getExtensionContext(): IExtensionContext
Retours
getHost()
Obtient des informations sur l’hôte (c’est-à-dire un organization Azure DevOps) que la page cible
function getHost(): IHostContext
Retours
getPageContext()
getService<T>(string)
Obtenez la contribution avec l’ID de contribution donné. La contribution retournée a une méthode pour 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 ciblée par la page
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 pour 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êter d’afficher l’indicateur de chargement)
function notifyLoadSucceeded(): Promise<void>
Retours
Promise<void>
ready()
Inscrivez un rappel qui est appelé une fois l’installation/la négociation initiale terminée. Si l’installation 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) un objet instance, soit (2) une fonction qui prend des données de contexte facultatives et retourne un objet instance.
resize(number, number)
Demande à la fenêtre parente de redimensionner le conteneur pour cette extension en fonction de la taille d’extension actuelle.
function resize(width?: number, height?: number)
Paramètres
- width
-
number
Largeur facultative, par défaut scrollWidth
- height
-
number
Hauteur facultative, par défaut scrollHeight
unregister(string)
Supprime un objet que cette extension a exposé au frame hôte.
function unregister(instanceId: string)
Paramètres
- instanceId
-
string
ID unique de l’objet inscrit
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour