azure-devops-extension-sdk package

Kelas

XDMChannel	Mewakili saluran komunikasi antara bingkai\dokumen Tetap "hidup" di beberapa panggilan funtion\method
XDMObjectRegistry	Katalog objek yang diekspos untuk XDM

Antarmuka

ContextIdentifier
GlobalizationContext
IExtensionContext	Pengidentifikasi untuk ekstensi saat ini
IExtensionInitOptions	Opsi untuk inisialisasi ekstensi -- diteruskan ke DevOps.init()
IHostContext	Informasi tentang host DevOps saat ini (organisasi)
IPageContext	Konteks global ditempatkan di setiap halaman web
ITeamContext	Informasi tentang tim DevOps saat ini
IUserContext	Informasi tentang pengguna saat ini
IJsonRpcMessage	Mewakili panggilan prosedur jarak jauh (rpc) antar bingkai.
ISerializationSettings	Pengaturan yang terkait dengan serialisasi data di seluruh batas iframe.
IXDMChannel	Antarmuka untuk satu saluran XDM
IXDMChannelManager	Registri saluran XDM disimpan per bingkai/jendela target
IXDMObjectRegistry	Registri objek XDM yang dapat dipanggil oleh saluran XDM

Enum

HostType

Tingkat host DevOps

Fungsi

applyTheme({[varName: string]: string})	Menerapkan variabel tema ke dokumen saat ini
getAccessToken()	Mengambil token akses yang akan memungkinkan panggilan dilakukan ke layanan DevOps lainnya
getAppToken()	Mengambil token yang dapat digunakan untuk mengidentifikasi pengguna saat ini
getConfiguration()	Dapatkan data konfigurasi yang diteruskan dalam jabat tangan awal dari bingkai induk
getContributionId()	Mendapatkan informasi tentang kontribusi yang pertama kali menyebabkan ekstensi ini dimuat.
getExtensionContext()	Dapatkan konteks tentang ekstensi yang memiliki konten yang sedang dihosting
getHost()	Mendapatkan informasi tentang host (yaitu organisasi Azure DevOps) yang ditargetkan halaman
getPageContext()	Mendapatkan konteks tentang halaman host
getService<T>(string)	Dapatkan kontribusi dengan id kontribusi yang diberikan. Kontribusi yang dikembalikan memiliki metode untuk mendapatkan objek terdaftar dalam kontribusi tersebut.
getTeamContext()	Mendapatkan informasi tentang tim yang ditargetkan halaman
getUser()	Mendapatkan informasi tentang pengguna saat ini
getWebContext()	Mendapatkan konteks tentang web
init(IExtensionInitOptions)	Memulai jabat tangan dengan jendela host.
notifyLoadFailed(string | Error)	Memberi tahu host bahwa ekstensi gagal dimuat
notifyLoadSucceeded()	Memberi tahu host bahwa ekstensi berhasil dimuat (berhenti memperlihatkan indikator pemuatan)
ready()	Daftarkan panggilan balik yang dipanggil setelah penyiapan/jabat tangan awal selesai. Jika penyiapan awal sudah selesai, panggilan balik dipanggil di akhir tumpukan panggilan saat ini.
register<T>(string, T)	Daftarkan objek (instans atau metode pabrik) yang diekspos ekstensi ini ke bingkai host.
resize(number, number)	Meminta jendela induk untuk mengubah ukuran kontainer untuk ekstensi ini berdasarkan ukuran ekstensi saat ini.
unregister(string)	Menghapus objek yang diekspos ekstensi ini ke bingkai host.

Detail Fungsi

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

Menerapkan variabel tema ke dokumen saat ini

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

Parameter

themeData

{[varName: string]: string}

getAccessToken()

Mengambil token akses yang akan memungkinkan panggilan dilakukan ke layanan DevOps lainnya

function getAccessToken(): Promise<string>

Mengembalikan

Promise<string>

getAppToken()

Mengambil token yang dapat digunakan untuk mengidentifikasi pengguna saat ini

function getAppToken(): Promise<string>

Mengembalikan

Promise<string>

getConfiguration()

Dapatkan data konfigurasi yang diteruskan dalam jabat tangan awal dari bingkai induk

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

Mengembalikan

{[key: string]: any}

getContributionId()

Mendapatkan informasi tentang kontribusi yang pertama kali menyebabkan ekstensi ini dimuat.

function getContributionId(): string

Mengembalikan

string

getExtensionContext()

Dapatkan konteks tentang ekstensi yang memiliki konten yang sedang dihosting

function getExtensionContext(): IExtensionContext

Mengembalikan

IExtensionContext

getHost()

Mendapatkan informasi tentang host (yaitu organisasi Azure DevOps) yang ditargetkan halaman

function getHost(): IHostContext

Mengembalikan

IHostContext

getPageContext()

Mendapatkan konteks tentang halaman host

function getPageContext(): IPageContext

Mengembalikan

IPageContext

getService<T>(string)

Dapatkan kontribusi dengan id kontribusi yang diberikan. Kontribusi yang dikembalikan memiliki metode untuk mendapatkan objek terdaftar dalam kontribusi tersebut.

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

Parameter

contributionId

string

Id kontribusi yang akan didapatkan

Mengembalikan

Promise<T>

getTeamContext()

Mendapatkan informasi tentang tim yang ditargetkan halaman

function getTeamContext(): ITeamContext

Mengembalikan

ITeamContext

getUser()

Mendapatkan informasi tentang pengguna saat ini

function getUser(): IUserContext

Mengembalikan

IUserContext

getWebContext()

Mendapatkan konteks tentang web

function getWebContext(): IWebContext

Mengembalikan

IWebContext

init(IExtensionInitOptions)

Memulai jabat tangan dengan jendela host.

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

Parameter

options

IExtensionInitOptions

Opsi inisialisasi untuk ekstensi.

Mengembalikan

Promise<void>

notifyLoadFailed(string | Error)

Memberi tahu host bahwa ekstensi gagal dimuat

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

Parameter

e

string | Error

Mengembalikan

Promise<void>

notifyLoadSucceeded()

Memberi tahu host bahwa ekstensi berhasil dimuat (berhenti memperlihatkan indikator pemuatan)

function notifyLoadSucceeded(): Promise<void>

Mengembalikan

Promise<void>

ready()

Daftarkan panggilan balik yang dipanggil setelah penyiapan/jabat tangan awal selesai. Jika penyiapan awal sudah selesai, panggilan balik dipanggil di akhir tumpukan panggilan saat ini.

function ready(): Promise<void>

Mengembalikan

Promise<void>

register<T>(string, T)

Daftarkan objek (instans atau metode pabrik) yang diekspos ekstensi ini ke bingkai host.

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

Parameter

instanceId

string

id unik objek terdaftar

instance

T

Baik: (1) instans objek, atau (2) fungsi yang mengambil data konteks opsional dan mengembalikan instans objek.

resize(number, number)

Meminta jendela induk untuk mengubah ukuran kontainer untuk ekstensi ini berdasarkan ukuran ekstensi saat ini.

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

Parameter

width

number

Lebar opsional, default untuk menggulirWidth

height

number

Tinggi opsional, default untuk menggulirHeight

unregister(string)

Menghapus objek yang diekspos ekstensi ini ke bingkai host.

function unregister(instanceId: string)

Parameter

instanceId

string

id unik objek terdaftar