azure-devops-extension-sdk package

Интерфейсы

ContextIdentifier
GlobalizationContext
IExtensionContext	Идентификатор текущего расширения
IExtensionInitOptions	Параметры инициализации расширения — переданы в DevOps.init()
IHostContext	Сведения о текущем узле DevOps (организация)
IPageContext	Глобальный контекст, размещенный на каждой веб-странице
ITeamContext	Сведения о текущей команде DevOps
IUserContext	Сведения о текущем пользователе

Перечисления

HostType

Уровень узла DevOps

Функции

applyTheme({[varName: string]: string})	Применение переменных темы к текущему документу
getAccessToken()	Получение маркера доступа, который позволит выполнять вызовы к другим службам DevOps
getAppToken()	Получение маркера, который можно использовать для идентификации текущего пользователя
getConfiguration()	Получение данных конфигурации, переданных в начальном подтверждении из родительского кадра
getContributionId()	Возвращает сведения о вкладе, который сначала вызвал загрузку этого расширения.
getExtensionContext()	Получение контекста о расширении, которому принадлежит содержимое, размещенное
getHost()	Получает сведения о узле (т. е. организации Azure DevOps), на которую ориентирована страница.
getPageContext()	Получение контекста о странице узла
getService<T>(string)	Получите вклад с указанным идентификатором вклада. Возвращаемый вклад имеет метод получения зарегистрированного объекта в рамках этого вклада.
getTeamContext()	Получает сведения о команде, на которую ориентирована страница
getUser()	Возвращает сведения о текущем пользователе
getWebContext()	Получение контекста о Интернете
init(IExtensionInitOptions)	Инициирует подтверждение с помощью окна узла.
notifyLoadFailed(string | Error)	Уведомляет узел о том, что расширение не удалось загрузить
notifyLoadSucceeded()	Уведомляет узел о том, что расширение успешно загружено (остановите отображение индикатора загрузки)
ready()	Зарегистрируйте обратный вызов, который вызывается после завершения начальной установки или подтверждения. Если начальная настройка уже завершена, обратный вызов вызывается в конце текущего стека вызовов.
register<T>(string, T)	Зарегистрируйте объект (метод экземпляра или фабрики), который этот расширение предоставляет кадру узла.
resize(number, number)	Запрашивает родительское окно, чтобы изменить размер контейнера для этого расширения на основе текущего размера расширения.
unregister(string)	Удаляет объект, предоставляемый этим расширением для кадра узла.

Переменные

sdkVersion

Номер версии веб-SDK. Можно задать в наборе требований расширения, например: vss-sdk-version/4.2

Сведения о функции

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

Применение переменных темы к текущему документу

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

Параметры

themeData

{[varName: string]: string}

getAccessToken()

Получение маркера доступа, который позволит выполнять вызовы к другим службам DevOps

function getAccessToken(): Promise<string>

Возвращаемое значение

Promise<string>

getAppToken()

Получение маркера, который можно использовать для идентификации текущего пользователя

function getAppToken(): Promise<string>

Возвращаемое значение

Promise<string>

getConfiguration()

Получение данных конфигурации, переданных в начальном подтверждении из родительского кадра

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

Возвращаемое значение

{[key: string]: any}

getContributionId()

Возвращает сведения о вкладе, который сначала вызвал загрузку этого расширения.

function getContributionId(): string

Возвращаемое значение

string

getExtensionContext()

Получение контекста о расширении, которому принадлежит содержимое, размещенное

function getExtensionContext(): IExtensionContext

Возвращаемое значение

IExtensionContext

getHost()

Получает сведения о узле (т. е. организации Azure DevOps), на которую ориентирована страница.

function getHost(): IHostContext

Возвращаемое значение

IHostContext

getPageContext()

Получение контекста о странице узла

function getPageContext(): IPageContext

Возвращаемое значение

IPageContext

getService<T>(string)

Получите вклад с указанным идентификатором вклада. Возвращаемый вклад имеет метод получения зарегистрированного объекта в рамках этого вклада.

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

Параметры

contributionId

string

Идентификатор вклада для получения

Возвращаемое значение

Promise<T>

getTeamContext()

Получает сведения о команде, на которую ориентирована страница

function getTeamContext(): ITeamContext

Возвращаемое значение

ITeamContext

getUser()

Возвращает сведения о текущем пользователе

function getUser(): IUserContext

Возвращаемое значение

IUserContext

getWebContext()

Получение контекста о Интернете

function getWebContext(): IWebContext

Возвращаемое значение

IWebContext

init(IExtensionInitOptions)

Инициирует подтверждение с помощью окна узла.

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

Параметры

options

IExtensionInitOptions

Параметры инициализации расширения.

Возвращаемое значение

Promise<void>

notifyLoadFailed(string | Error)

Уведомляет узел о том, что расширение не удалось загрузить

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

Параметры

e

string | Error

Возвращаемое значение

Promise<void>

notifyLoadSucceeded()

Уведомляет узел о том, что расширение успешно загружено (остановите отображение индикатора загрузки)

function notifyLoadSucceeded(): Promise<void>

Возвращаемое значение

Promise<void>

ready()

Зарегистрируйте обратный вызов, который вызывается после завершения начальной установки или подтверждения. Если начальная настройка уже завершена, обратный вызов вызывается в конце текущего стека вызовов.

function ready(): Promise<void>

Возвращаемое значение

Promise<void>

register<T>(string, T)

Зарегистрируйте объект (метод экземпляра или фабрики), который этот расширение предоставляет кадру узла.

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

Параметры

instanceId

string

уникальный идентификатор зарегистрированного объекта

instance

T

Либо: (1) экземпляр объекта или (2) функция, которая принимает необязательные данные контекста и возвращает экземпляр объекта.

resize(number, number)

Запрашивает родительское окно, чтобы изменить размер контейнера для этого расширения на основе текущего размера расширения.

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

Параметры

width

number

Необязательная ширина, по умолчанию для прокруткиWidth

height

number

Необязательная высота, по умолчанию — scrollHeight

unregister(string)

Удаляет объект, предоставляемый этим расширением для кадра узла.

function unregister(instanceId: string)

Параметры

instanceId

string

уникальный идентификатор зарегистрированного объекта

Variable Details

sdkVersion

Номер версии веб-SDK. Можно задать в наборе требований расширения, например: vss-sdk-version/4.2

sdkVersion: 4.2

Тип

4.2