azure-devops-extension-sdk package

Classi

XDMChannel	Rappresenta un canale di comunicazione tra frame\documento Rimane "vivo" tra più chiamate di funtion\metodo
XDMObjectRegistry	Catalogo di oggetti esposti per XDM

Interfacce

ContextIdentifier
GlobalizationContext
IExtensionContext	Identificatore per l'estensione corrente
IExtensionInitOptions	Opzioni per l'inizializzazione dell'estensione - passata a DevOps.init()
IHostContext	Informazioni sull'host DevOps corrente (organizzazione)
IPageContext	Contesto globale inserito in ogni pagina Web
ITeamContext	Informazioni sul team DevOps corrente
IUserContext	Informazioni sull'utente corrente
IJsonRpcMessage	Rappresenta una chiamata di routine remota (rpc) tra frame.
ISerializationSettings	Impostazioni correlate alla serializzazione dei dati tra i limiti del frame.
IXDMChannel	Interfaccia per un singolo canale XDM
IXDMChannelManager	Registro di sistema di canali XDM mantenuti per frame/finestra di destinazione
IXDMObjectRegistry	Registro di sistema di oggetti XDM che possono essere richiamati da un canale XDM

Enumerazioni

HostType

Livello host DevOps

Funzioni

applyTheme({[varName: string]: string})	Applica le variabili del tema al documento corrente
getAccessToken()	Recuperare un token di accesso che consentirà di effettuare chiamate ad altri servizi DevOps
getAppToken()	Recuperare un token che può essere usato per identificare l'utente corrente
getConfiguration()	Ottenere i dati di configurazione passati nella handshake iniziale dal frame padre
getContributionId()	Ottiene le informazioni sul contributo che ha prima causato il caricamento di questa estensione.
getExtensionContext()	Ottenere il contesto sull'estensione proprietaria del contenuto ospitato
getHost()	Ottiene informazioni sull'host ,ad esempio un'organizzazione Azure DevOps, destinata alla pagina
getPageContext()	Ottenere il contesto sulla pagina host
getService<T>(string)	Ottenere il contributo con l'ID contributo specificato. Il contributo restituito ha un metodo per ottenere un oggetto registrato all'interno di tale contributo.
getTeamContext()	Ottiene informazioni sul team di destinazione della pagina
getUser()	Ottiene informazioni sull'utente corrente
getWebContext()	Ottenere il contesto sul Web
init(IExtensionInitOptions)	Avvia l'handshake con la finestra host.
notifyLoadFailed(string | Error)	Notifica all'host che l'estensione non è riuscita a caricare
notifyLoadSucceeded()	Notifica all'host che l'estensione è stata caricata correttamente (arresto che mostra l'indicatore di caricamento)
ready()	Registrare un callback che viene chiamato una volta completata l'installazione iniziale/handshake. Se la configurazione iniziale è già stata completata, il callback viene richiamato alla fine dello stack di chiamate corrente.
register<T>(string, T)	Registrare un oggetto (istanza o metodo factory) che questa estensione espone al frame host.
resize(number, number)	Richiede alla finestra padre di ridimensionare il contenitore per questa estensione in base alle dimensioni correnti dell'estensione.
unregister(string)	Rimuove un oggetto esposto all'estensione al frame host.

Dettagli funzione

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

Applica le variabili del tema al documento corrente

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

Parametri

themeData

{[varName: string]: string}

getAccessToken()

Recuperare un token di accesso che consentirà di effettuare chiamate ad altri servizi DevOps

function getAccessToken(): Promise<string>

Restituisce

Promise<string>

getAppToken()

Recuperare un token che può essere usato per identificare l'utente corrente

function getAppToken(): Promise<string>

Restituisce

Promise<string>

getConfiguration()

Ottenere i dati di configurazione passati nella handshake iniziale dal frame padre

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

Restituisce

{[key: string]: any}

getContributionId()

Ottiene le informazioni sul contributo che ha prima causato il caricamento di questa estensione.

function getContributionId(): string

Restituisce

string

getExtensionContext()

Ottenere il contesto sull'estensione proprietaria del contenuto ospitato

function getExtensionContext(): IExtensionContext

Restituisce

IExtensionContext

getHost()

Ottiene informazioni sull'host ,ad esempio un'organizzazione Azure DevOps, destinata alla pagina

function getHost(): IHostContext

Restituisce

IHostContext

getPageContext()

Ottenere il contesto sulla pagina host

function getPageContext(): IPageContext

Restituisce

IPageContext

getService<T>(string)

Ottenere il contributo con l'ID contributo specificato. Il contributo restituito ha un metodo per ottenere un oggetto registrato all'interno di tale contributo.

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

Parametri

contributionId

string

ID del contributo da ottenere

Restituisce

Promise<T>

getTeamContext()

Ottiene informazioni sul team di destinazione della pagina

function getTeamContext(): ITeamContext

Restituisce

ITeamContext

getUser()

Ottiene informazioni sull'utente corrente

function getUser(): IUserContext

Restituisce

IUserContext

getWebContext()

Ottenere il contesto sul Web

function getWebContext(): IWebContext

Restituisce

IWebContext

init(IExtensionInitOptions)

Avvia l'handshake con la finestra host.

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

Parametri

options

IExtensionInitOptions

Opzioni di inizializzazione per l'estensione.

Restituisce

Promise<void>

notifyLoadFailed(string | Error)

Notifica all'host che l'estensione non è riuscita a caricare

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

Parametri

e

string | Error

Restituisce

Promise<void>

notifyLoadSucceeded()

Notifica all'host che l'estensione è stata caricata correttamente (arresto che mostra l'indicatore di caricamento)

function notifyLoadSucceeded(): Promise<void>

Restituisce

Promise<void>

ready()

Registrare un callback che viene chiamato una volta completata l'installazione iniziale/handshake. Se la configurazione iniziale è già stata completata, il callback viene richiamato alla fine dello stack di chiamate corrente.

function ready(): Promise<void>

Restituisce

Promise<void>

register<T>(string, T)

Registrare un oggetto (istanza o metodo factory) che questa estensione espone al frame host.

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

Parametri

instanceId

string

ID univoco dell'oggetto registrato

instance

T

O: (1) un'istanza dell'oggetto o (2) una funzione che accetta dati di contesto facoltativi e restituisce un'istanza dell'oggetto.

resize(number, number)

Richiede alla finestra padre di ridimensionare il contenitore per questa estensione in base alle dimensioni correnti dell'estensione.

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

Parametri

width

number

Larghezza facoltativa, impostazione predefinita per scorrimentoWidth

height

number

Altezza facoltativa, impostazione predefinita per scrollHeight

unregister(string)

Rimuove un oggetto esposto all'estensione al frame host.

function unregister(instanceId: string)

Parametri

instanceId

string

ID univoco dell'oggetto registrato