ExtensionManagementRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

ExtensionManagementRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

createDocumentByName(any, string, string, string, string, string)
deleteDocumentByName(string, string, string, string, string, string)
deleteRequest(string, string)
getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)	API ini dipanggil oleh halaman akuisisi/instal untuk mendapatkan kemungkinan tindakan pengguna seperti Beli/Permintaan
getAuditLog(string, string)
getAuthorization(string, string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Dapatkan ekstensi yang diinstal berdasarkan nama penerbit dan ekstensinya.
getInstalledExtensions(boolean, boolean, string[], boolean)	Cantumkan ekstensi yang diinstal dalam koleksi akun/proyek.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Cantumkan informasi status dan versi untuk semua ekstensi yang diinstal.
getToken()
installExtensionByName(string, string, string)	Instal ekstensi yang ditentukan ke dalam koleksi akun / proyek.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Kueri untuk satu atau beberapa kumpulan data untuk ekstensi yang ditentukan. Catatan: token yang digunakan untuk otorisasi harus telah dikeluarkan atas nama ekstensi yang ditentukan.
queryExtensions(InstalledExtensionQuery)
registerAuthorization(string, string, string)
requestAcquisition(ExtensionAcquisitionRequest)
requestExtension(string, string, string)
resolveAllRequests(string, string, string, ExtensionRequestState)
resolveRequest(string, string, string, string, ExtensionRequestState)
setDocumentByName(any, string, string, string, string, string)
uninstallExtensionByName(string, string, string, string)	Copot pemasangan ekstensi yang ditentukan dari koleksi akun/proyek.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Perbarui ekstensi yang diinstal. Biasanya API ini digunakan untuk mengaktifkan atau menonaktifkan ekstensi.

Detail Konstruktor

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createDocumentByName(any, string, string, string, string, string)

function createDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Parameter

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Mengembalikan

Promise<any>

deleteDocumentByName(string, string, string, string, string, string)

function deleteDocumentByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string, documentId: string): Promise<void>

Parameter

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Mengembalikan

Promise<void>

deleteRequest(string, string)

function deleteRequest(publisherName: string, extensionName: string): Promise<void>

Parameter

publisherName

string

extensionName

string

Mengembalikan

Promise<void>

getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)

API ini dipanggil oleh halaman akuisisi/instal untuk mendapatkan kemungkinan tindakan pengguna seperti Beli/Permintaan

function getAcquisitionOptions(itemId: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean, isAccountOwner?: boolean, isLinked?: boolean, isConnectedServer?: boolean, isBuyOperationValid?: boolean): Promise<AcquisitionOptions>

Parameter

itemId

string

Nama ekstensi yang sepenuhnya memenuhi syarat (<publisher_id>.<extension_id>)

testCommerce

boolean

Parameter untuk menguji ekstensi pratinjau berbayar tanpa membuat paket azure menjadi publik

isFreeOrTrialInstall

boolean

Parameter mewakili alur kerja penginstalan atau uji coba (diperlukan untuk alur penginstalan lama)

isAccountOwner

boolean

Parameter mewakili apakah pengguna adalah pemilik atau PCA akun

isLinked

boolean

Parameter mewakili apakah akun ditautkan dengan langganan

isConnectedServer

boolean

Parameter mewakili apakah operasi Beli harus dievaluasi

isBuyOperationValid

boolean

Mengembalikan

Promise<AcquisitionOptions>

getAuditLog(string, string)

function getAuditLog(publisherName: string, extensionName: string): Promise<ExtensionAuditLog>

Parameter

publisherName

string

extensionName

string

Mengembalikan

Promise<ExtensionAuditLog>

getAuthorization(string, string, string)

function getAuthorization(publisherName: string, extensionName: string, registrationId: string): Promise<ExtensionAuthorization>

Parameter

publisherName

string

extensionName

string

registrationId

string

Mengembalikan

Promise<ExtensionAuthorization>

getDocumentByName(string, string, string, string, string, string)

function getDocumentByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string, documentId: string): Promise<any>

Parameter

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Mengembalikan

Promise<any>

getDocumentsByName(string, string, string, string, string)

function getDocumentsByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any[]>

Parameter

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Mengembalikan

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Dapatkan ekstensi yang diinstal berdasarkan nama penerbit dan ekstensinya.

function getInstalledExtensionByName(publisherName: string, extensionName: string, assetTypes?: string[]): Promise<InstalledExtension>

Parameter

publisherName

string

Nama penerbit. Contoh: "fabrikam".

extensionName

string

Nama ekstensi. Contoh: "alat operasi".

assetTypes

string[]

Menentukan file mana yang dikembalikan dalam array file. Berikan karakter pengganti '*' untuk mengembalikan semua file, atau daftar yang dipisahkan titik dua untuk mengambil file dengan jenis aset tertentu.

Mengembalikan

Promise<InstalledExtension>

getInstalledExtensions(boolean, boolean, string[], boolean)

Cantumkan ekstensi yang diinstal dalam koleksi akun/proyek.

function getInstalledExtensions(includeDisabledExtensions?: boolean, includeErrors?: boolean, assetTypes?: string[], includeInstallationIssues?: boolean): Promise<InstalledExtension[]>

Parameter

includeDisabledExtensions

boolean

Jika true (default), sertakan ekstensi yang dinonaktifkan dalam hasil.

includeErrors

boolean

Jika true, sertakan ekstensi yang diinstal dengan error.

assetTypes

string[]

Menentukan file mana yang dikembalikan dalam array file. Berikan karakter pengganti '*' untuk mengembalikan semua file, atau daftar yang dipisahkan titik dua untuk mengambil file dengan jenis aset tertentu.

includeInstallationIssues

boolean

Mengembalikan

Promise<InstalledExtension[]>

getPolicies(string)

function getPolicies(userId: string): Promise<UserExtensionPolicy>

Parameter

userId

string

Mengembalikan

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Mengembalikan

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Cantumkan informasi status dan versi untuk semua ekstensi yang diinstal.

function getStates(includeDisabled?: boolean, includeErrors?: boolean, includeInstallationIssues?: boolean, forceRefresh?: boolean): Promise<ExtensionState[]>

Parameter

includeDisabled

boolean

Jika true (default), sertakan ekstensi yang dinonaktifkan dalam hasil.

includeErrors

boolean

Jika true, sertakan ekstensi yang diinstal dalam status error dalam hasil.

includeInstallationIssues

boolean

forceRefresh

boolean

Mengembalikan

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Mengembalikan

Promise<string>

installExtensionByName(string, string, string)

Instal ekstensi yang ditentukan ke dalam koleksi akun / proyek.

function installExtensionByName(publisherName: string, extensionName: string, version?: string): Promise<InstalledExtension>

Parameter

publisherName

string

Nama penerbit. Contoh: "fabrikam".

extensionName

string

Nama ekstensi. Contoh: "alat operasi".

version

string

Mengembalikan

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Kueri untuk satu atau beberapa kumpulan data untuk ekstensi yang ditentukan. Catatan: token yang digunakan untuk otorisasi harus telah dikeluarkan atas nama ekstensi yang ditentukan.

function queryCollectionsByName(collectionQuery: ExtensionDataCollectionQuery, publisherName: string, extensionName: string): Promise<ExtensionDataCollection[]>

Parameter

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Nama penerbit. Contoh: "fabrikam".

extensionName

string

Nama ekstensi. Contoh: "alat operasi".

Mengembalikan

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

function queryExtensions(query: InstalledExtensionQuery): Promise<InstalledExtension[]>

Parameter

query

InstalledExtensionQuery

Mengembalikan

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

function registerAuthorization(publisherName: string, extensionName: string, registrationId: string): Promise<ExtensionAuthorization>

Parameter

publisherName

string

extensionName

string

registrationId

string

Mengembalikan

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>

Parameter

acquisitionRequest

ExtensionAcquisitionRequest

Mengembalikan

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

function requestExtension(publisherName: string, extensionName: string, requestMessage: string): Promise<RequestedExtension>

Parameter

publisherName

string

extensionName

string

requestMessage

string

Mengembalikan

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

function resolveAllRequests(rejectMessage: string, publisherName: string, extensionName: string, state: ExtensionRequestState): Promise<number>

Parameter

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Mengembalikan

Promise<number>

resolveRequest(string, string, string, string, ExtensionRequestState)

function resolveRequest(rejectMessage: string, publisherName: string, extensionName: string, requesterId: string, state: ExtensionRequestState): Promise<number>

Parameter

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Mengembalikan

Promise<number>

setDocumentByName(any, string, string, string, string, string)

function setDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Parameter

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Mengembalikan

Promise<any>

uninstallExtensionByName(string, string, string, string)

Copot pemasangan ekstensi yang ditentukan dari koleksi akun/proyek.

function uninstallExtensionByName(publisherName: string, extensionName: string, reason?: string, reasonCode?: string): Promise<void>

Parameter

publisherName

string

Nama penerbit. Contoh: "fabrikam".

extensionName

string

Nama ekstensi. Contoh: "alat operasi".

reason

string

reasonCode

string

Mengembalikan

Promise<void>

updateDocumentByName(any, string, string, string, string, string)

function updateDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Parameter

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Mengembalikan

Promise<any>

updateInstalledExtension(InstalledExtension)

Perbarui ekstensi yang diinstal. Biasanya API ini digunakan untuk mengaktifkan atau menonaktifkan ekstensi.

function updateInstalledExtension(extension: InstalledExtension): Promise<InstalledExtension>

Parameter

extension

InstalledExtension

Mengembalikan

Promise<InstalledExtension>