remote-config package

Firebase 원격 구성 웹 SDK 이 SDK는 Node.js 환경에서 작동하지 않습니다.

함수

함수 설명
function(앱, ...)
getRemoteConfig(앱)
function(remoteConfig, ...)
activate(remoteConfig) 마지막으로 가져온 구성을 getter에 제공합니다.
confirmInitialized(remoteConfig) 마지막으로 활성화된 구성을 getter에 사용할 수 있는지 확인합니다.
fetchAndActivate(remoteConfig) 편의를 위해 가져오기 및 활성화 작업을 수행합니다.
fetchConfig(remoteConfig) 원격 구성 서비스에서 구성을 가져오고 캐시합니다.
getAll(remoteConfig) 모든 구성을 가져옵니다.
getboolean(remoteConfig, key) 지정된 키의 값을 부울로 가져옵니다.remoteConfig.getValue(key).asBoolean()를 호출하는 편리한 메서드입니다.
getNumber(remoteConfig, key) 지정된 키의 값을 숫자로 가져옵니다.remoteConfig.getValue(key).asNumber()를 호출하는 편의 메서드입니다.
getString(remoteConfig, key) 지정된 키의 값을 문자열로 가져옵니다. remoteConfig.getValue(key).asString()를 호출하는 편의 메서드입니다.
getValue(remoteConfig, key) 지정된 키의 Value를 가져옵니다.
setLogLevel(remoteConfig, logLevel) 사용할 로그 수준을 정의합니다.
함수()
isSupported() 이 메서드는 두 가지 검사를 제공합니다.1. 브라우저 환경에 IndexedDB가 있는지 확인합니다. 2. 현재 브라우저 컨텍스트에서 IndexedDB open() 호출을 허용하는지 확인합니다.

인터페이스

인터페이스 설명
RemoteConfig Firebase 원격 구성 서비스 인터페이스입니다.
RemoteConfigSettings 원격 구성 SDK의 구성 옵션을 정의합니다.
값 메타데이터 및 유형에 안전한 getter로 값을 래핑합니다.

유형 별칭

별칭 입력 설명
FetchStatus Firebase 원격 구성 서버에서 구성을 가져오려는 마지막 시도의 결과를 요약합니다.
  • 'no-fetch-yet' RemoteConfig 인스턴스가 아직 구성 가져오기를 시도하지 않았거나 SDK 초기화가 완료되지 않았음을 나타냅니다.
  • '성공' 는 마지막 시도가 성공했음을 나타냅니다.
  • "실패" 는 마지막 시도가 실패했음을 나타냅니다.
  • '제한' 는 마지막 시도가 비율이 제한되었음을 나타냅니다.
로그 수준 원격 구성 로깅의 수준을 정의합니다.
ValueSource 값의 소스를 나타냅니다.
  • '정적' 는 값이 정적 상수에 의해 정의되었음을 나타냅니다.
  • '기본' 는 값이 기본 config로 정의되었음을 나타냅니다.
  • "remote" 는 가져온 구성으로 값이 정의되었음을 나타냅니다.

함수(앱, ...)

getRemoteConfig(앱)

서명:

export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;

매개변수

매개변수 유형 설명
앱 Firebase 앱 FirebaseApp 인스턴스

반환:

RemoteConfig

RemoteConfig 인스턴스

function(remoteConfig, ...)

활성화(원격 구성)

마지막으로 가져온 구성을 getter에 제공합니다.

서명:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스

반환:

Promise&lt;boolean&gt;

현재 호출이 가져온 구성을 활성화하면 true로 확인되는 Promise입니다. 가져온 구성이 이미 활성화된 경우 Promise가 false로 확인됩니다.

sureInitialized(remoteConfig)

마지막으로 활성화된 구성을 getter에 사용할 수 있는지 확인합니다.

서명:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스

반환:

프로미스<void>

getter가 마지막으로 활성화된 구성을 사용할 수 있는 시점을 확인하는 Promise입니다.

importAndActivate(remoteConfig)

편의를 위해 가져오기 및 활성화 작업을 수행합니다.

서명:

export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스

반환:

Promise&lt;boolean&gt;

현재 호출이 가져온 구성을 활성화하면 true로 확인되는 Promise입니다. 가져온 구성이 이미 활성화된 경우 Promise가 false로 확인됩니다.

importConfig(remoteConfig)

원격 구성 서비스에서 구성을 가져오고 캐시합니다.

서명:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스

반환:

프로미스<void>

getAll(remoteConfig)

모든 구성을 가져옵니다.

서명:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스

반환:

레코드<문자열, 값>

모든 구성

getboolean(remoteConfig, 키)

지정된 키의 값을 부울로 가져옵니다.

remoteConfig.getValue(key).asBoolean()를 호출하는 편의 메서드입니다.

서명:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스
키 문자열 매개변수의 이름입니다.

반환:

부울

부울인 지정된 키의 값입니다.

getNumber(remoteConfig, 키)

지정된 키의 값을 숫자로 가져옵니다.

remoteConfig.getValue(key).asNumber()를 호출하는 편의 메서드입니다.

서명:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스
키 문자열 매개변수의 이름입니다.

반환:

숫자

지정된 키의 값입니다(숫자).

getString(remoteConfig, key)

지정된 키의 값을 문자열로 가져옵니다. remoteConfig.getValue(key).asString()를 호출하는 편의 메서드입니다.

서명:

export declare function getString(remoteConfig: RemoteConfig, key: string): string;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스
키 문자열 매개변수의 이름입니다.

반환:

문자열

문자열 형식의 지정된 키 값입니다.

getValue(remoteConfig, 키)

지정된 키의 Value를 가져옵니다.

서명:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스
키 문자열 매개변수의 이름입니다.

반환:

값

지정된 키의 값입니다.

setLogLevel(remoteConfig, logLevel)

사용할 로그 수준을 정의합니다.

서명:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

매개변수

매개변수 유형 설명
원격 구성 RemoteConfig RemoteConfig 인스턴스
logLevel RemoteConfigLogLevel 설정할 로그 수준입니다.

반환:

void

함수()

isSupported()

이 메서드는 두 가지 검사를 제공합니다.

  1. 브라우저 환경에 IndexedDB가 있는지 확인합니다. 2. 현재 브라우저 컨텍스트에서 IndexedDB open() 호출을 허용하는지 확인합니다.

서명:

export declare function isSupported(): Promise<boolean>;

반환:

Promise&lt;boolean&gt;

Promise: 이 환경에서 RemoteConfig 인스턴스를 초기화할 수 있으면 true, 초기화할 수 없으면 false로 확인됩니다.

가져오기 상태

Firebase 원격 구성 서버에서 구성을 가져오려는 마지막 시도의 결과를 요약합니다.

  • 'no-fetch-yet' [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) 인스턴스가 아직 구성을 가져오려고 시도하지 않았거나 SDK 초기화가 완료되지 않았음을 나타냅니다.
  • '성공' 는 마지막 시도가 성공했음을 나타냅니다.
  • "실패" 는 마지막 시도가 실패했음을 나타냅니다.
  • '제한' 는 마지막 시도가 비율이 제한되었음을 나타냅니다.

서명:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

LogLevel

원격 구성 로깅의 수준을 정의합니다.

서명:

export declare type LogLevel = 'debug' | 'error' | 'silent';

값 소스

값의 소스를 나타냅니다.

  • '정적' 는 값이 정적 상수에 의해 정의되었음을 나타냅니다.
  • '기본' 는 값이 기본 config로 정의되었음을 나타냅니다.
  • "remote" 는 가져온 구성으로 값이 정의되었음을 나타냅니다.

서명:

export declare type ValueSource = 'static' | 'default' | 'remote';