azure-devops-extension-sdk package

Классы

XDMChannel	Представляет канал обмена данными между кадрами\документ остается "активным" в нескольких вызовах funtion\method
XDMObjectRegistry	Каталог объектов, предоставляемых для XDM

Интерфейсы

ContextIdentifier
GlobalizationContext
IExtensionContext	Идентификатор текущего расширения
IExtensionInitOptions	Параметры инициализации расширения передаются в DevOps.init()
IHostContext	Сведения о текущем узле DevOps (организация)
IPageContext	Глобальный контекст, размещенный на каждой веб-странице
ITeamContext	Сведения о текущей команде DevOps
IUserContext	Сведения о текущем пользователе
IJsonRpcMessage	Представляет удаленный вызов процедуры (rpc) между кадрами.
ISerializationSettings	Параметры, связанные с сериализацией данных через границы iframe.
IXDMChannel	Интерфейс для одного канала XDM
IXDMChannelManager	Реестр каналов XDM, хранящихся для каждого целевого кадра или окна
IXDMObjectRegistry	Реестр объектов XDM, которые могут вызываться каналом XDM

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

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)	Удаляет объект, который это расширение предоставило кадру узла.

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

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

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

height

number

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

unregister(string)

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

function unregister(instanceId: string)

Параметры

instanceId

string

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