Firebase 원격 구성 웹 SDK. 이 SDK는 Node.js 환경에서 작동하지 않습니다.
기능
기능 | 설명 |
---|---|
기능(앱, ...) | |
getRemoteConfig(앱) | |
기능(remoteConfig, ...) | |
활성화(원격 구성) | 마지막으로 가져온 구성을 getter에서 사용할 수 있도록 만듭니다. |
초기화 보장(remoteConfig) | 마지막으로 활성화된 구성을 getter에서 사용할 수 있는지 확인합니다. |
fetchAndActivate(원격 구성) | 편의에 따라 가져오기 및 활성화 작업을 수행합니다. |
fetchConfig(원격 구성) | 원격 구성 서비스에서 구성을 가져오고 캐시합니다. |
getAll(원격 구성) | 모든 구성을 가져옵니다. |
getBoolean(remoteConfig, 키) | 주어진 키의 값을 부울로 가져옵니다. remoteConfig.getValue(key).asBoolean() 호출하기 위한 편리한 메서드입니다. |
getNumber(remoteConfig, 키) | 주어진 키의 값을 숫자로 가져옵니다. remoteConfig.getValue(key).asNumber() 호출하기 위한 편리한 메서드입니다. |
getString(remoteConfig, 키) | 주어진 키의 값을 문자열로 가져옵니다. remoteConfig.getValue(key).asString() 호출하기 위한 편리한 메서드입니다. |
getValue(remoteConfig, 키) | 지정된 키의 값을 가져옵니다. |
setLogLevel(remoteConfig, logLevel) | 사용할 로그 수준을 정의합니다. |
기능() | |
지원됨() | 이 방법은 두 가지 검사를 제공합니다. 1. 브라우저 환경에 IndexedDB가 존재하는지 확인합니다. 2. 현재 브라우저 컨텍스트가 IndexedDB open() 호출을 허용하는지 확인하십시오. |
인터페이스
상호 작용 | 설명 |
---|---|
원격 구성 | Firebase 원격 구성 서비스 인터페이스입니다. |
원격 구성 설정 | 원격 구성 SDK의 구성 옵션을 정의합니다. |
값 | 메타데이터 및 유형 안전 getter로 값을 래핑합니다. |
유형 별칭
유형 별칭 | 설명 |
---|---|
가져오기 상태 | Firebase 원격 구성 서버에서 구성을 가져오려는 마지막 시도의 결과를 요약합니다.
|
로그레벨 | 원격 구성 로깅 수준을 정의합니다. |
가치 소스 | 값의 소스를 나타냅니다.
|
기능(앱, ...)
getRemoteConfig(앱)
서명:
export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
앱 | Firebase앱 | FirebaseApp 인스턴스입니다. |
보고:
RemoteConfig 인스턴스.
기능(remoteConfig, ...)
활성화(원격 구성)
마지막으로 가져온 구성을 getter에서 사용할 수 있도록 만듭니다.
서명:
export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
보고:
약속<부울>
현재 호출이 가져온 구성을 활성화한 경우 true로 확인되는 Promise
입니다. 가져온 구성이 이미 활성화된 경우 Promise
false로 확인됩니다.
초기화 보장(remoteConfig)
마지막으로 활성화된 구성을 getter에서 사용할 수 있는지 확인합니다.
서명:
export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
보고:
약속<공허>
getter가 마지막으로 활성화된 구성을 사용할 수 있는 시기를 확인하는 Promise
.
fetchAndActivate(원격 구성)
편의에 따라 가져오기 및 활성화 작업을 수행합니다.
서명:
export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
보고:
약속<부울>
현재 호출이 가져온 구성을 활성화한 경우 true로 확인되는 Promise
입니다. 가져온 구성이 이미 활성화된 경우 Promise
false로 확인됩니다.
fetchConfig(원격 구성)
원격 구성 서비스에서 구성을 가져오고 캐시합니다.
서명:
export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
보고:
약속<공허>
getAll(원격 구성)
모든 구성을 가져옵니다.
서명:
export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
보고:
레코드<문자열, 값 >
모든 구성.
getBoolean(remoteConfig, 키)
주어진 키의 값을 부울로 가져옵니다.
remoteConfig.getValue(key).asBoolean()
호출하기 위한 편리한 메서드입니다.
서명:
export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
열쇠 | 끈 | 매개변수의 이름입니다. |
보고:
부울
주어진 키의 값(부울)입니다.
getNumber(remoteConfig, 키)
주어진 키의 값을 숫자로 가져옵니다.
remoteConfig.getValue(key).asNumber()
호출하기 위한 편리한 메서드입니다.
서명:
export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
열쇠 | 끈 | 매개변수의 이름입니다. |
보고:
숫자
주어진 키의 값(숫자)입니다.
getString(remoteConfig, 키)
주어진 키의 값을 문자열로 가져옵니다. remoteConfig.getValue(key).asString()
호출하기 위한 편리한 메서드입니다.
서명:
export declare function getString(remoteConfig: RemoteConfig, key: string): string;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
열쇠 | 끈 | 매개변수의 이름입니다. |
보고:
끈
문자열로 지정된 키의 값입니다.
getValue(remoteConfig, 키)
지정된 키의 값을 가져옵니다.
서명:
export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
열쇠 | 끈 | 매개변수의 이름입니다. |
보고:
지정된 키의 값입니다.
setLogLevel(remoteConfig, logLevel)
사용할 로그 수준을 정의합니다.
서명:
export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원격 구성 | 원격 구성 | RemoteConfig 인스턴스. |
로그레벨 | 원격 구성로그 수준 | 설정할 로그 수준입니다. |
보고:
무효의
기능()
지원됨()
이 방법은 두 가지 검사를 제공합니다.
- 브라우저 환경에 IndexedDB가 존재하는지 확인하세요. 2. 현재 브라우저 컨텍스트가 IndexedDB
open()
호출을 허용하는지 확인하십시오.
서명:
export declare function isSupported(): Promise<boolean>;
보고:
약속<부울>
이 환경에서 RemoteConfig 인스턴스를 초기화할 수 있으면 true로, 초기화할 수 없으면 false로 확인되는 Promise
입니다.
가져오기 상태
Firebase 원격 구성 서버에서 구성을 가져오려는 마지막 시도의 결과를 요약합니다.
- "no-fetch-yet"은 [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) 인스턴스가 아직 구성 가져오기를 시도하지 않았거나 SDK 초기화가 완료되지 않았음을 나타냅니다.
- "성공"은 마지막 시도가 성공했음을 나타냅니다.
- "실패"는 마지막 시도가 실패했음을 나타냅니다.
- "throttle"은 마지막 시도가 속도 제한되었음을 나타냅니다.
서명:
export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
로그레벨
원격 구성 로깅 수준을 정의합니다.
서명:
export declare type LogLevel = 'debug' | 'error' | 'silent';
가치 소스
값의 소스를 나타냅니다.
- "정적"은 값이 정적 상수에 의해 정의되었음을 나타냅니다.
- "default"는 값이 기본 구성에 의해 정의되었음을 나타냅니다.
- "remote"는 값이 가져온 구성에 의해 정의되었음을 나타냅니다.
서명:
export declare type ValueSource = 'static' | 'default' | 'remote';