Firebase RemoteConfig 서비스 인터페이스
서명:
export declare class RemoteConfig
속성
| 속성 | 특수키 | 유형 | 설명 |
|---|---|---|---|
| app | 앱 |
방법
| 방법 | 특수키 | 설명 |
|---|---|---|
| createTemplateFromJSON(json) | JSON 문자열에서 새 원격 구성 템플릿을 만들고 반환합니다. | |
| getServerTemplate(옵션) | ServerTemplate을 인스턴스화한 후 프로젝트의 최신 템플릿 버전을 가져와 캐시합니다. | |
| getTemplate()을 사용하면 됩니다. | 프로젝트의 RemoteConfigTemplate의 현재 활성 버전을 가져옵니다. | |
| getTemplateAtVersion(versionNumber) | 프로젝트의 요청된 RemoteConfigTemplate 버전을 가져옵니다. | |
| initServerTemplate(옵션) | 동기적으로 ServerTemplate을 인스턴스화합니다. | |
| listVersions(options) | 게시되었고 시간 역순으로 정렬된 원격 구성 템플릿 버전의 목록을 가져옵니다. 최근 버전 300개만 저장됩니다. 비활성 원격 구성 템플릿에 해당하는 모든 버전 (즉, 클라이언트가 가져오는 템플릿을 제외한 모든 버전)도 90일이 지나면 삭제됩니다. | |
| publishTemplate(템플릿, 옵션) | 원격 구성 템플릿을 게시합니다. | |
| rollback(versionNumber) | 프로젝트의 게시된 원격 구성 템플릿을 지정된 버전으로 롤백합니다. 롤백은 이전에 게시된 원격 구성 템플릿을 가져오고 강제 업데이트를 사용하여 다시 게시하는 것과 같습니다. | |
| validateTemplate(템플릿) | RemoteConfigTemplate의 유효성을 검사합니다. |
RemoteConfig.app
서명:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
JSON 문자열에서 새 원격 구성 템플릿을 만들고 반환합니다.
서명:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| json | 문자열 | 원격 구성 템플릿을 채울 JSON 문자열입니다. |
반환:
새 템플릿 인스턴스입니다.
RemoteConfig.getServerTemplate()
ServerTemplate을 인스턴스화한 후 프로젝트의 최신 템플릿 버전을 가져와 캐시합니다.
서명:
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | GetServerTemplateOptions |
반환:
프로미스<ServerTemplate>
RemoteConfig.getTemplate()
프로젝트의 RemoteConfigTemplate의 현재 활성 버전을 가져옵니다.
서명:
getTemplate(): Promise<RemoteConfigTemplate>;
반환:
프로미스<RemoteConfigTemplate>
RemoteConfigTemplate를 사용하여 처리하는 프로미스입니다.
RemoteConfig.getTemplateAtVersion()
프로젝트의 요청된 RemoteConfigTemplate 버전을 가져옵니다.
서명:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 버전 번호 | 숫자 | 문자열 | 조회할 원격 구성 템플릿의 버전 번호입니다. |
반환:
프로미스<RemoteConfigTemplate>
RemoteConfigTemplate를 사용하여 처리하는 프로미스입니다.
RemoteConfig.initServerTemplate()
동기적으로 ServerTemplate을 인스턴스화합니다.
서명:
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | InitServerTemplateOptions |
반환:
RemoteConfig.listVersions()
게시되었고 시간 역순으로 정렬된 원격 구성 템플릿 버전의 목록을 가져옵니다. 최근 버전 300개만 저장됩니다. 비활성 원격 구성 템플릿에 해당하는 모든 버전 (즉, 클라이언트가 가져오는 템플릿을 제외한 모든 버전)도 90일이 지나면 삭제됩니다.
서명:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | ListVersionsOptions | 버전 목록을 가져오기 위한 선택적 옵션 객체입니다. |
반환:
프로미스<ListVersionsResult>
ListVersionsResult를 사용하여 처리하는 프로미스입니다.
RemoteConfig.publishTemplate()
원격 구성 템플릿을 게시합니다.
서명:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 템플릿 | RemoteConfigTemplate | 게시할 원격 구성 템플릿입니다. |
| 옵션 | { force: boolean; } | 원격 구성 템플릿을 게시할 때 선택 가능한 옵션 객체: - force: true로 설정하면 원격 구성 템플릿이 강제로 업데이트되고 ETag를 우회합니다. 이 방법은 여러 클라이언트에서 원격 구성 템플릿을 업데이트할 경우 원격 구성 템플릿의 업데이트가 손실될 수 있으므로 권장되지 않습니다. ETag 사용 및 강제 업데이트를 참고하세요. |
반환:
프로미스<RemoteConfigTemplate>
게시된 RemoteConfigTemplate을(를) 통해 이행되는 프로미스입니다.
RemoteConfig.rollback()
프로젝트의 게시된 원격 구성 템플릿을 지정된 버전으로 롤백합니다. 롤백은 이전에 게시된 원격 구성 템플릿을 가져오고 강제 업데이트를 사용하여 다시 게시하는 것과 같습니다.
서명:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 버전 번호 | 숫자 | 문자열 | 롤백할 원격 구성 템플릿의 버전 번호입니다. 지정된 버전 번호는 현재 버전 번호보다 낮아야 하며 비활성으로 인해 삭제된 적이 없어야 합니다. 최근 버전 300개만 저장됩니다. 비활성 원격 구성 템플릿에 해당하는 모든 버전 (클라이언트에서 가져오는 템플릿을 제외한 모든 버전)도 90일이 지나면 삭제됩니다. |
반환:
프로미스<RemoteConfigTemplate>
게시된 RemoteConfigTemplate을 사용하여 처리하는 프로미스입니다.
RemoteConfig.validateTemplate()
RemoteConfigTemplate의 유효성을 검사합니다.
서명:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 템플릿 | RemoteConfigTemplate | 검증할 원격 구성 템플릿입니다. |
반환:
프로미스<RemoteConfigTemplate>
검증된 RemoteConfigTemplate를 사용하여 처리하는 프로미스입니다.