IHostNavigationService interface

패키지:

azure-devops-extension-api

호스트 창의 탐색(URL, 새 창 등)과 상호 작용하기 위한 서비스

메서드

getHash()	현재 해시를 가져옵니다.
getPageNavigationElements()	현재 페이지에서 선택한 탐색 요소 집합(예: 허브 및 허브 그룹)을 가져옵니다.
getPageRoute()	현재 페이지에 대해 일치하는 경로에 대한 정보를 가져옵니다.
getQueryParams()	호스트 페이지의 URL에서 현재 쿼리 매개 변수 집합을 가져옵니다.
navigate(string)	상위 페이지를 지정된 URL로 이동합니다.
onHashChanged((hash: string) => void)	해시 탐색이 변경될 때마다 호출할 콜백을 추가합니다.
openNewWindow(string, string)	지정된 URL에 대한 새 창 열기
reload()	상위 프레임을 다시 로드합니다.
replaceHash(string)	기존 해시를 호스팅된 콘텐츠에서 제공된 해시로 바꿉니다.
setDocumentTitle(string)	호스트 문서의 제목을 업데이트합니다(브라우저 탭 제목으로 표시됨).
setHash(string)	호스팅된 콘텐츠에서 제공된 해시를 설정합니다.
setQueryParams({[key: string]: string})	호스트 페이지에서 하나 이상의 쿼리 매개 변수를 설정합니다

메서드 세부 정보

getHash()

현재 해시를 가져옵니다.

function getHash(): Promise<string>

반환

Promise<string>

getPageNavigationElements()

현재 페이지에서 선택한 탐색 요소 집합(예: 허브 및 허브 그룹)을 가져옵니다.

function getPageNavigationElements(): Promise<INavigationElement[]>

반환

Promise<INavigationElement[]>

getPageRoute()

현재 페이지에 대해 일치하는 경로에 대한 정보를 가져옵니다.

function getPageRoute(): Promise<IPageRoute>

반환

Promise<IPageRoute>

getQueryParams()

호스트 페이지의 URL에서 현재 쿼리 매개 변수 집합을 가져옵니다.

function getQueryParams(): Promise<{[key: string]: string}>

반환

Promise<{[key: string]: string}>

navigate(string)

상위 페이지를 지정된 URL로 이동합니다.

function navigate(url: string)

매개 변수

url

string

탐색할 URL

onHashChanged((hash: string) => void)

해시 탐색이 변경될 때마다 호출할 콜백을 추가합니다.

function onHashChanged(callback: (hash: string) => void)

매개 변수

callback

(hash: string) => void

각 탐색 해시 변경에서 호출되는 메서드

openNewWindow(string, string)

지정된 URL에 대한 새 창 열기

function openNewWindow(url: string, features: string)

매개 변수

url

string

새 창의 URL

features

string

window.open에 3번째 매개변수로 전송된 쉼표로 구분된 기능/사양 목록입니다. 예: "height=400,width=400".

reload()

상위 프레임을 다시 로드합니다.

function reload()

replaceHash(string)

기존 해시를 호스팅된 콘텐츠에서 제공된 해시로 바꿉니다.

function replaceHash(hash: string)

매개 변수

hash

string

setDocumentTitle(string)

호스트 문서의 제목을 업데이트합니다(브라우저 탭 제목으로 표시됨).

function setDocumentTitle(title: string)

매개 변수

title

string

창의 새 제목

setHash(string)

호스팅된 콘텐츠에서 제공된 해시를 설정합니다.

function setHash(hash: string)

매개 변수

hash

string

setQueryParams({[key: string]: string})

호스트 페이지에서 하나 이상의 쿼리 매개 변수를 설정합니다

function setQueryParams(parameters: {[key: string]: string})

매개 변수

parameters

{[key: string]: string}

추가, 업데이트 또는 제거할 쿼리 문자열 매개 변수의 사전(제거할 빈 값 전달)