SyncConfigsProvider

Kotlin

프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 SyncDatabase의 초기화 정보를 구성하고 제공합니다.

Summary

Public companion functions

createFromConfigFile()

suspend fun createFromConfigFile(
            context: Context,
            authType: SupportedAuthType = SupportedAuthType.CCG,
            configFileName: String = "config.yaml"
        ):ResultCompat<SyncConfigsProvider>

assets의 설정 파일을 읽어, SyncDatabase 초기화에 필요한 정보를 제공하는 SyncConfigsProvider를 생성합니다.

Parameters
context: Context	Context
authType: SupportedAuthType	인증 타입으로, 현재는 Client Credentials Grant만 사용되며 기본값으로 설정되어 있습니다.
configFileName: String	SyncConfigsProvider 생성을 위한 assets 폴더 내 설정 파일 이름입니다. 현재 기본값은 config.yaml이지만, 필요에 따라 파일명을 변경하고 이를 매개변수에 반영하여 사용할 수 있습니다.

Returns
ResultCompat<SyncConfigsProvider>	SyncDatabase 초기화에 필요한 정보를 제공하는 provider 생성 결과를 캡슐화하는 wrapper class입니다. provider는 프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 초기화 정보를 구성하고 제공합니다.

Java

프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 SyncDatabase의 초기화 정보를 구성하고 제공합니다.

Summary

Public static methods

createFromConfigFile()

ResultCompat<SyncConfigsProvider> createFromConfigFile(
    @NonNull Context context,
    @NonNull SupportedAuthType authType,
    @NonNull String configFileName
):

assets의 설정 파일을 읽어, SyncDatabase 초기화에 필요한 정보를 제공하는 SyncConfigsProvider를 생성합니다.

Parameters
@NonNull Context context	Context
@NonNull SupportedAuthType authType	인증 타입으로, 현재는 Client Credentials Grant만 사용되며 기본값으로 설정되어 있습니다.
@NonNull String configFileName	SyncConfigsProvider 생성을 위한 assets 폴더 내 설정 파일 이름입니다. 현재 기본값은 config.yaml이지만, 필요에 따라 파일명을 변경하고 이를 매개변수에 반영하여 사용할 수 있습니다.

Returns
ResultCompat<SyncConfigsProvider>	SyncDatabase 초기화에 필요한 정보를 제공하는 provider 생성 결과를 캡슐화하는 wrapper class입니다. provider는 프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 초기화 정보를 구성하고 제공합니다.