chrome.extension

설명

chrome.extension API에는 모든 확장 프로그램 페이지에서 사용할 수 있는 유틸리티가 있습니다. 메시지 전달에 자세히 설명된 것처럼 확장 프로그램과 콘텐츠 스크립트 간에 또는 확장 프로그램 간에 메시지를 교환할 수 있는 지원이 포함됩니다.

유형

ViewType

Chrome 44 이상

확장 프로그램 뷰의 유형입니다.

열거형

속성

inIncognitoContext

시크릿 탭 내에서 실행되는 콘텐츠 스크립트와 시크릿 프로세스 내에서 실행되는 확장 프로그램 페이지의 경우 true입니다. 후자는 'split' 시크릿_동작을 사용하는 확장 프로그램에만 적용됩니다.

유형

boolean

lastError

≤ MV2 Chrome 58부터 지원 중단됨

runtime.lastError을(를) 사용하세요.

비동기 확장 API로 인해 오류가 발생한 경우 콜백의 전체 기간 동안 설정됩니다. 오류가 발생하지 않으면 lastError가 undefined입니다.

유형

객체

속성

  • 메시지

    string

    발생한 오류에 대한 설명입니다.

방법

getBackgroundPage()

포그라운드 전용 
chrome.extension.getBackgroundPage()

현재 확장 프로그램 내에서 실행되는 백그라운드 페이지에 대한 자바스크립트 'window' 객체를 반환합니다. 확장 프로그램에 백그라운드 페이지가 없는 경우 null을 반환합니다.

반환 값

  • 기간|정의되지 않음

getExtensionTabs()

≤ MV2 포그라운드 전용 지원 중단됨
chrome.extension.getExtensionTabs(
  windowId?: number,
)

extension.getViews {type: "tab"}을(를) 사용하세요.

현재 확장 프로그램 내에서 실행되는 각 탭에 대한 자바스크립트 'window' 객체의 배열을 반환합니다. windowId가 지정되면 지정된 창에 연결된 탭의 '창' 객체만 반환합니다.

매개변수

  • windowId

    number 선택사항

반환 값

  • 창[]

    전역 윈도우 객체의 배열

getURL()

≤ MV2 Chrome 58부터 지원 중단됨
chrome.extension.getURL(
  path: string,
)

runtime.getURL을(를) 사용하세요.

확장 프로그램 설치 디렉터리 내의 상대 경로를 정규화된 URL로 변환합니다.

매개변수

  • 경로

    string

    설치 디렉터리를 기준으로 표시된 확장 프로그램 내의 리소스 경로입니다.

반환 값

  • string

    리소스의 정규화된 URL입니다.

getViews()

포그라운드 전용 
chrome.extension.getViews(
  fetchProperties?: object,
)

현재 확장 프로그램 내에서 실행되는 각 페이지에 대한 자바스크립트 'window' 객체의 배열을 반환합니다.

매개변수

  • fetchProperties

    객체 선택사항

    • tabId

      number 선택사항

      Chrome 54 이상

      탭 ID에 따라 뷰를 찾습니다. 이 필드를 생략하면 모든 뷰가 반환됩니다.

    • 유형

      ViewType 선택사항

      가져올 뷰의 유형입니다. 생략하면 백그라운드 페이지 및 탭을 포함한 모든 뷰가 반환됩니다.

    • windowId

      number 선택사항

      검색을 제한할 창입니다. 생략하면 모든 뷰가 반환됩니다.

반환 값

  • 창[]

    전역 객체 배열

isAllowedFileSchemeAccess()

프로미스 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

확장 프로그램의 'file://' 스키마에 대한 액세스 상태를 검색합니다. 이는 chrome://extensions 페이지를 통해 액세스할 수 있는, 확장 프로그램별로 사용자가 제어하는 '파일 URL에 대한 액세스 허용' 설정에 해당합니다.

매개변수

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      확장 프로그램이 'file://' 스키마에 액세스할 수 있는 경우 true, 그렇지 않은 경우 false입니다.

반환 값

  • Promise<boolean>

    Chrome 99 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

isAllowedIncognitoAccess()

프로미스 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

확장 프로그램의 시크릿 모드 액세스 상태를 검색합니다. 이는 chrome://extensions 페이지를 통해 액세스할 수 있는, 사용자가 제어하는 확장 프로그램별 '시크릿 모드에서 허용됨' 설정에 해당합니다.

매개변수

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      확장 프로그램에서 시크릿 모드에 액세스할 수 있는 경우 true, 그렇지 않은 경우 false입니다.

반환 값

  • Promise<boolean>

    Chrome 99 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

sendRequest()

프로미스 &leq; MV2 지원 중단됨
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

runtime.sendMessage을(를) 사용하세요.

확장 프로그램 내의 다른 리스너에 단일 요청을 보냅니다. runtime.connect와 비슷하지만 선택적 응답과 함께 단일 요청만 전송합니다. extension.onRequest 이벤트는 확장 프로그램의 각 페이지에서 실행됩니다.

매개변수

  • extensionId

    문자열 선택사항

    연결할 확장 프로그램의 확장 프로그램 ID입니다. 생략할 경우 기본값은 자체 확장 프로그램입니다.

  • 요청

    모두

  • 콜백

    함수 선택사항

    Chrome 99 이상

    callback 매개변수는 다음과 같습니다. 

    (response: any)=>void

    • 응답

      모두

      요청의 핸들러가 보낸 JSON 응답 객체입니다. 확장 프로그램에 연결하는 동안 오류가 발생하면 콜백이 인수 없이 호출되고 runtime.lastError가 오류 메시지로 설정됩니다.

반환 값

  • 프로미스<any>

    Chrome 99 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

확장 프로그램의 업데이트 URL에 사용되는 ap CGI 매개변수의 값을 설정합니다. Chrome 확장 프로그램 갤러리에서 호스팅되는 확장 프로그램의 경우 이 값이 무시됩니다.

매개변수

  • 데이터

    string

이벤트

onRequest

&leq; MV2 지원 중단됨
chrome.extension.onRequest.addListener(
  callback: function,
)

runtime.onMessage을(를) 사용하세요.

확장 프로세스 또는 콘텐츠 스크립트에서 요청이 전송되면 시작됩니다.

매개변수

  • 콜백

    기능

    callback 매개변수는 다음과 같습니다. 

    (request: any,sender: runtime.MessageSender,sendResponse: function)=>void

    • 요청

      모두

    • sendResponse

      기능

      sendResponse 매개변수는 다음과 같습니다. 

      ()=>void

onRequestExternal

&leq; MV2 지원 중단됨
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

runtime.onMessageExternal을(를) 사용하세요.

다른 확장 프로그램에서 요청을 보내면 시작됩니다.

매개변수

  • 콜백

    기능

    callback 매개변수는 다음과 같습니다. 

    (request: any,sender: runtime.MessageSender,sendResponse: function)=>void

    • 요청

      모두

    • sendResponse

      기능

      sendResponse 매개변수는 다음과 같습니다. 

      ()=>void