azure-devops-extension-sdk package

Sınıflar

XDMChannel	Çerçeveler\belge arasındaki iletişim kanalını temsil eder Birden çok funtion\method çağrısında "etkin" kalır
XDMObjectRegistry	XDM için kullanıma sunulan nesnelerin kataloğu

Arabirimler

ContextIdentifier
GlobalizationContext
IExtensionContext	Geçerli uzantının tanımlayıcısı
IExtensionInitOptions	Uzantı başlatma seçenekleri -- DevOps.init() öğesine geçirilir
IHostContext	Geçerli DevOps konağı (kuruluş) hakkında bilgi
IPageContext	Her web sayfasına yerleştirilen genel bağlam
ITeamContext	Geçerli DevOps ekibi hakkında bilgi
IUserContext	Geçerli kullanıcı hakkındaki bilgiler
IJsonRpcMessage	Çerçeveler arasındaki uzak yordam çağrısını (rpc) temsil eder.
ISerializationSettings	Verilerin iframe sınırları arasında seri hale getirilmesiyle ilgili ayarlar.
IXDMChannel	Tek bir XDM kanalı için arabirim
IXDMChannelManager	Hedef çerçeve/pencere başına tutulan XDM kanallarının kayıt defteri
IXDMObjectRegistry	XDM kanalı tarafından çağrılabilen XDM nesnelerinin kayıt defteri

Numaralandırmalar

HostType

DevOps konak düzeyi

İşlevler

applyTheme({[varName: string]: string})	Tema değişkenlerini geçerli belgeye uygular
getAccessToken()	Diğer DevOps hizmetlerine çağrı yapılmasına izin veren bir erişim belirteci getirme
getAppToken()	Geçerli kullanıcıyı tanımlamak için kullanılabilecek bir belirteç getirme
getConfiguration()	Üst çerçeveden ilk el sıkışmasında geçirilen yapılandırma verilerini alma
getContributionId()	Bu uzantının yüklenmesine neden olan katkı hakkındaki bilgileri alır.
getExtensionContext()	Barındırılan içeriğe sahip uzantıyla ilgili bağlamı alma
getHost()	Sayfanın hedef aldığı konak (örneğin bir Azure DevOps kuruluşu) hakkında bilgi alır
getPageContext()	Konak sayfasıyla ilgili bağlamı alma
getService<T>(string)	Verilen katkı kimliğiyle katkıyı alın. Döndürülen katkı, bu katkı içinde kayıtlı bir nesne almak için bir yönteme sahiptir.
getTeamContext()	Sayfanın hedef aldığı ekip hakkında bilgi alır
getUser()	Geçerli kullanıcı hakkında bilgi alır
getWebContext()	Web hakkında bağlamı alma
init(IExtensionInitOptions)	Konak penceresiyle el sıkışmasını başlatır.
notifyLoadFailed(string | Error)	Uzantının yüklenemediği ana bilgisayara bildirir
notifyLoadSucceeded()	Uzantının başarıyla yüklendiğini konağa bildirir (yükleme göstergesini göstermeyi durdur)
ready()	İlk kurulum/el sıkışması tamamlandıktan sonra çağrılan bir geri arama kaydedin. İlk kurulum zaten tamamlandıysa, geçerli çağrı yığınının sonunda geri çağırma çağrılır.
register<T>(string, T)	Bu uzantının konak çerçevesinde kullanıma sunan bir nesneyi (örnek veya fabrika yöntemi) kaydedin.
resize(number, number)	Geçerli uzantı boyutuna göre bu uzantının kapsayıcısını yeniden boyutlandırmak için üst pencereye istekte bulunur.
unregister(string)	Bu uzantının konak çerçevesine açık olan bir nesneyi kaldırır.

İşlev Ayrıntıları

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

Tema değişkenlerini geçerli belgeye uygular

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

Parametreler

themeData

{[varName: string]: string}

getAccessToken()

Diğer DevOps hizmetlerine çağrı yapılmasına izin veren bir erişim belirteci getirme

function getAccessToken(): Promise<string>

Döndürülenler

Promise<string>

getAppToken()

Geçerli kullanıcıyı tanımlamak için kullanılabilecek bir belirteç getirme

function getAppToken(): Promise<string>

Döndürülenler

Promise<string>

getConfiguration()

Üst çerçeveden ilk el sıkışmasında geçirilen yapılandırma verilerini alma

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

Döndürülenler

{[key: string]: any}

getContributionId()

Bu uzantının yüklenmesine neden olan katkı hakkındaki bilgileri alır.

function getContributionId(): string

Döndürülenler

string

getExtensionContext()

Barındırılan içeriğe sahip uzantıyla ilgili bağlamı alma

function getExtensionContext(): IExtensionContext

Döndürülenler

IExtensionContext

getHost()

Sayfanın hedef aldığı konak (örneğin bir Azure DevOps kuruluşu) hakkında bilgi alır

function getHost(): IHostContext

Döndürülenler

IHostContext

getPageContext()

Konak sayfasıyla ilgili bağlamı alma

function getPageContext(): IPageContext

Döndürülenler

IPageContext

getService<T>(string)

Verilen katkı kimliğiyle katkıyı alın. Döndürülen katkı, bu katkı içinde kayıtlı bir nesne almak için bir yönteme sahiptir.

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

Parametreler

contributionId

string

Alınacak katkının kimliği

Döndürülenler

Promise<T>

getTeamContext()

Sayfanın hedef aldığı ekip hakkında bilgi alır

function getTeamContext(): ITeamContext

Döndürülenler

ITeamContext

getUser()

Geçerli kullanıcı hakkında bilgi alır

function getUser(): IUserContext

Döndürülenler

IUserContext

getWebContext()

Web hakkında bağlamı alma

function getWebContext(): IWebContext

Döndürülenler

IWebContext

init(IExtensionInitOptions)

Konak penceresiyle el sıkışmasını başlatır.

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

Parametreler

options

IExtensionInitOptions

Uzantı için başlatma seçenekleri.

Döndürülenler

Promise<void>

notifyLoadFailed(string | Error)

Uzantının yüklenemediği ana bilgisayara bildirir

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

Parametreler

e

string | Error

Döndürülenler

Promise<void>

notifyLoadSucceeded()

Uzantının başarıyla yüklendiğini konağa bildirir (yükleme göstergesini göstermeyi durdur)

function notifyLoadSucceeded(): Promise<void>

Döndürülenler

Promise<void>

ready()

İlk kurulum/el sıkışması tamamlandıktan sonra çağrılan bir geri arama kaydedin. İlk kurulum zaten tamamlandıysa, geçerli çağrı yığınının sonunda geri çağırma çağrılır.

function ready(): Promise<void>

Döndürülenler

Promise<void>

register<T>(string, T)

Bu uzantının konak çerçevesinde kullanıma sunan bir nesneyi (örnek veya fabrika yöntemi) kaydedin.

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

Parametreler

instanceId

string

kayıtlı nesnenin benzersiz kimliği

instance

T

Şunlardan biri: (1) bir nesne örneği veya (2) isteğe bağlı bağlam verilerini alıp bir nesne örneği döndüren bir işlev.

resize(number, number)

Geçerli uzantı boyutuna göre bu uzantının kapsayıcısını yeniden boyutlandırmak için üst pencereye istekte bulunur.

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

Parametreler

width

number

İsteğe bağlı genişlik, varsayılan olarak scrollWidth olarak ayarlanır

height

number

İsteğe bağlı yükseklik, varsayılan olarak scrollHeight olarak ayarlanır

unregister(string)

Bu uzantının konak çerçevesine açık olan bir nesneyi kaldırır.

function unregister(instanceId: string)

Parametreler

instanceId

string

kayıtlı nesnenin benzersiz kimliği