chrome.extension

설명

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

유형

ViewType

Chrome 44 이상

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

열거형

"tab"

"popup"

속성

inIncognitoContext

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

유형

부울

lastError

≤ MV2 Chrome 58부터 지원 중단됨

runtime.lastError를 사용하세요.

비동기 확장 프로그램 API에서 오류가 발생한 경우 콜백의 수명 동안 설정됩니다. 오류가 발생하지 않은 경우 lastError는 undefined입니다.

유형

객체

속성

  • 메시지

    문자열

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

메서드

getBackgroundPage()

포그라운드만 
chrome.extension.getBackgroundPage(): Window | undefined

현재 확장 프로그램 내에서 실행되는 백그라운드 페이지의 JavaScript 'window' 객체를 반환합니다. 확장에 백그라운드 페이지가 없으면 null을 반환합니다.

반환 값

  • window | undefined

getExtensionTabs()

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

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

현재 확장 프로그램 내에서 실행되는 각 탭의 JavaScript 'window' 객체 배열을 반환합니다. windowId가 지정된 경우 지정된 창에 연결된 탭의 'window' 객체만 반환합니다.

매개변수

  • windowId

    번호 선택사항

반환 값

  • Window[]

    전역 창 객체의 배열

getURL()

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

runtime.getURL를 사용하세요.

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

매개변수

  • 경로

    문자열

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

반환 값

  • 문자열

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

getViews()

포그라운드만 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

현재 확장 프로그램 내에서 실행되는 각 페이지의 JavaScript 'window' 객체 배열을 반환합니다.

매개변수

  • fetchProperties

    객체 선택사항

    • tabId

      번호 선택사항

      Chrome 54 이상

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

    • 유형

      ViewType 선택사항

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

    • windowId

      번호 선택사항

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

반환 값

  • Window[]

    전역 객체의 배열

isAllowedFileSchemeAccess()

Promise 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

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

매개변수

  • callback

    함수 선택사항

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      부울

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

반환 값

  • Promise<boolean>

    Chrome 99 이상

    Promise는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

isAllowedIncognitoAccess()

Promise 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

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

매개변수

  • callback

    함수 선택사항

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      부울

      확장 프로그램이 시크 모드에 액세스할 수 있으면 true, 그렇지 않으면 false입니다.

반환 값

  • Promise<boolean>

    Chrome 99 이상

    Promise는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

sendRequest()

Promise &leq; MV2 지원 중단됨
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

runtime.sendMessage를 사용하세요.

확장 프로그램 내의 다른 리스너에게 단일 요청을 전송합니다. runtime.connect와 유사하지만 선택적 응답이 포함된 단일 요청만 전송합니다. extension.onRequest 이벤트는 확장 프로그램의 각 페이지에서 발생합니다.

매개변수

  • extensionId

    문자열 선택사항

    연결하려는 확장 프로그램의 확장 프로그램 ID입니다. 생략하면 기본값은 자체 확장 프로그램입니다.

  • 요청

    모두

  • callback

    함수 선택사항

    Chrome 99 이상

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

    (response: any) => void

    • 응답

      모두

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

반환 값

  • Promise<any>

    Chrome 99 이상

    Promise는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

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

매개변수

  • 데이터

    문자열

이벤트

onRequest

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

runtime.onMessage를 사용하세요.

확장 프로그램 프로세스 또는 콘텐츠 스크립트에서 요청이 전송될 때 발생합니다.

매개변수

  • callback

    함수

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

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

    • 요청

      모두

    • sendResponse

      함수

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

      () => void

onRequestExternal

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

runtime.onMessageExternal를 사용하세요.

다른 확장 프로그램에서 요청이 전송될 때 발생합니다.

매개변수

  • callback

    함수

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

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

    • 요청

      모두

    • sendResponse

      함수

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

      () => void