azure-devops-extension-sdk package
Osztályok
XDMChannel |
A keretek\dokumentum közötti kommunikáció csatornáját jelöli, amely "életben marad" több funtion\metódushívás között |
XDMObjectRegistry |
Az XDM-hez közzétett objektumok katalógusa |
Interfészek
ContextIdentifier | |
GlobalizationContext | |
IExtensionContext |
Az aktuális bővítmény azonosítója |
IExtensionInitOptions |
Bővítmény inicializálásának lehetőségei – átadva a DevOps.init() számára |
IHostContext |
Információk az aktuális DevOps-gazdagépről (szervezet) |
IPageContext |
Az egyes weblapokon elhelyezett globális környezet |
ITeamContext |
Információk az aktuális DevOps-csapatról |
IUserContext |
Információk az aktuális felhasználóról |
IJsonRpcMessage |
Távoli eljáráshívást (rpc) jelöl a keretek között. |
ISerializationSettings |
Az adatok iframe-határok közötti szerializálásával kapcsolatos beállítások. |
IXDMChannel |
Egyetlen XDM-csatorna felülete |
IXDMChannelManager |
A célkeretenként/ablakban tárolt XDM-csatornák beállításjegyzéke |
IXDMObjectRegistry |
XDM-csatorna által meghívható XDM-objektumok beállításjegyzéke |
Enumerációk
HostType |
DevOps-gazdagép szintje |
Függvények
apply |
Témaváltozók alkalmazása az aktuális dokumentumra |
get |
Hozzáférési jogkivonat lekérése, amely lehetővé teszi a más DevOps-szolgáltatások felé irányuló hívások indítását |
get |
Jogkivonat lekérése, amely az aktuális felhasználó azonosítására használható |
get |
A kezdeti kézfogásban átadott konfigurációs adatok lekérése a szülőkeretből |
get |
Lekéri a bővítmény betöltését okozó hozzájárulással kapcsolatos információkat. |
get |
Az üzemeltetett tartalom tulajdonosi bővítményének kontextusának lekérése |
get |
Információt kap arról a gazdagépről (pl. egy Azure DevOps-szervezetről), amelyet az oldal megcélzott |
get |
A gazdagépoldal környezetének lekérése |
get |
Kérje le a hozzájárulást a megadott hozzájárulási azonosítóval. A visszaadott hozzájárulásnak van egy metódusa, amellyel be lehet szerezni egy regisztrált objektumot a hozzájáruláson belül. |
get |
Információt kap arról a csapatról, amelyet az oldal megcélzott |
get |
Az aktuális felhasználóval kapcsolatos információk lekérése |
get |
A weben lévő környezet lekérése |
init(IExtension |
A kézfogást a gazdagép ablakával indítja el. |
notify |
Értesíti a gazdagépet, hogy a bővítmény betöltése nem sikerült |
notify |
Értesíti a gazdagépet, hogy a bővítmény sikeresen betöltődött (a betöltésjelző megjelenítésének leállítása) |
ready() | Regisztráljon egy visszahívást, amely a kezdeti beállítás/kézfogás befejezése után lesz meghívva. Ha a kezdeti beállítás már befejeződött, a visszahívás az aktuális hívásverem végén lesz meghívva. |
register<T>(string, T) | Regisztráljon egy objektumot (példányt vagy gyári metódust), amelyet ez a bővítmény elérhetővé tesz a gazdagépkeret számára. |
resize(number, number) | Kéri a szülőablakot, hogy méretezze át a bővítmény tárolóját az aktuális bővítményméret alapján. |
unregister(string) | Eltávolít egy objektumot, amelyet ez a bővítmény elérhetővé téve a gazdagépkeretnek. |
Függvény adatai
applyTheme({[varName: string]: string})
Témaváltozók alkalmazása az aktuális dokumentumra
function applyTheme(themeData: {[varName: string]: string})
Paraméterek
- themeData
-
{[varName: string]: string}
getAccessToken()
Hozzáférési jogkivonat lekérése, amely lehetővé teszi a más DevOps-szolgáltatások felé irányuló hívások indítását
function getAccessToken(): Promise<string>
Válaszok
Promise<string>
getAppToken()
Jogkivonat lekérése, amely az aktuális felhasználó azonosítására használható
function getAppToken(): Promise<string>
Válaszok
Promise<string>
getConfiguration()
A kezdeti kézfogásban átadott konfigurációs adatok lekérése a szülőkeretből
function getConfiguration(): {[key: string]: any}
Válaszok
{[key: string]: any}
getContributionId()
Lekéri a bővítmény betöltését okozó hozzájárulással kapcsolatos információkat.
function getContributionId(): string
Válaszok
string
getExtensionContext()
Az üzemeltetett tartalom tulajdonosi bővítményének kontextusának lekérése
function getExtensionContext(): IExtensionContext
Válaszok
getHost()
Információt kap arról a gazdagépről (pl. egy Azure DevOps-szervezetről), amelyet az oldal megcélzott
function getHost(): IHostContext
Válaszok
getPageContext()
A gazdagépoldal környezetének lekérése
function getPageContext(): IPageContext
Válaszok
getService<T>(string)
Kérje le a hozzájárulást a megadott hozzájárulási azonosítóval. A visszaadott hozzájárulásnak van egy metódusa, amellyel be lehet szerezni egy regisztrált objektumot a hozzájáruláson belül.
function getService<T>(contributionId: string): Promise<T>
Paraméterek
- contributionId
-
string
A lekéréshez kapott hozzájárulás azonosítója
Válaszok
Promise<T>
getTeamContext()
Információt kap arról a csapatról, amelyet az oldal megcélzott
function getTeamContext(): ITeamContext
Válaszok
getUser()
Az aktuális felhasználóval kapcsolatos információk lekérése
function getUser(): IUserContext
Válaszok
getWebContext()
A weben lévő környezet lekérése
function getWebContext(): IWebContext
Válaszok
IWebContext
init(IExtensionInitOptions)
A kézfogást a gazdagép ablakával indítja el.
function init(options?: IExtensionInitOptions): Promise<void>
Paraméterek
- options
- IExtensionInitOptions
A bővítmény inicializálási lehetőségei.
Válaszok
Promise<void>
notifyLoadFailed(string | Error)
Értesíti a gazdagépet, hogy a bővítmény betöltése nem sikerült
function notifyLoadFailed(e: string | Error): Promise<void>
Paraméterek
- e
-
string | Error
Válaszok
Promise<void>
notifyLoadSucceeded()
Értesíti a gazdagépet, hogy a bővítmény sikeresen betöltődött (a betöltésjelző megjelenítésének leállítása)
function notifyLoadSucceeded(): Promise<void>
Válaszok
Promise<void>
ready()
Regisztráljon egy visszahívást, amely a kezdeti beállítás/kézfogás befejezése után lesz meghívva. Ha a kezdeti beállítás már befejeződött, a visszahívás az aktuális hívásverem végén lesz meghívva.
function ready(): Promise<void>
Válaszok
Promise<void>
register<T>(string, T)
Regisztráljon egy objektumot (példányt vagy gyári metódust), amelyet ez a bővítmény elérhetővé tesz a gazdagépkeret számára.
function register<T>(instanceId: string, instance: T)
Paraméterek
- instanceId
-
string
a regisztrált objektum egyedi azonosítója
- instance
-
T
Vagy: (1) objektumpéldány, vagy (2) olyan függvény, amely opcionális környezeti adatokat vesz fel, és egy objektumpéldányt ad vissza.
resize(number, number)
Kéri a szülőablakot, hogy méretezze át a bővítmény tárolóját az aktuális bővítményméret alapján.
function resize(width?: number, height?: number)
Paraméterek
- width
-
number
Választható szélesség, alapértelmezés szerint scrollWidth
- height
-
number
Nem kötelező magasság, alapértelmezés szerint scrollHeight
unregister(string)
Eltávolít egy objektumot, amelyet ez a bővítmény elérhetővé téve a gazdagépkeretnek.
function unregister(instanceId: string)
Paraméterek
- instanceId
-
string
a regisztrált objektum egyedi azonosítója