SyncDatabase
- Kotlin
- Java
SyncDatabase에 접근할 수 있는 entry point이며 초기화 이후 getInstance()를 호출하여, 해당 database와 연결된 SyncDatabase의 instance를 가져올 수 있습니다. SyncDatabase에 있는 document를 읽고 쓰려면 document()를 사용하세요.
Summary
| Public companion functions | |
|---|---|
| InitializationState | SyncDatabase SyncDatabase를 동기 방식으로 초기화합니다. |
| Unit | SyncDatabase SyncDatabase를 비동기 방식(callback)으로 초기화합니다. |
| SyncDatabase? | SyncDatabase 해당 database와 연결된 SyncDatabase의 instance를 반환합니다. |
| Unit | SyncDatabase의 모든 연결과 리소스를 정리합니다. |
| Public functions | |
|---|---|
| SyncDocument | 해당 database의 document를 반환합니다. |
Public companion functions
initialize()
initialize(application: Application, syncConfigsProvider: SyncConfigsProvider)
SyncDatabase를 동기방식으로 초기화합니다.
| Parameters | |
|---|---|
application: Application | Application |
syncConfigsProvider: SyncConfigsProvider | SyncDatabase 초기화에 필요한 정보를 제공하는 Provider입니다. Provider는 프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 초기화 정보를 구성하고 제공합니다. |
| Returns | |
|---|---|
| InitializationState | 각 database의 초기화 상태 및 그에 영향을 미친 정보를 제공하는 map 형태의 데이터 구조입니다. |
initialize()
initialize(application: Application, syncConfigsProvider: SyncConfigsProvider, listener: DatabaseListener)
SyncDatabase를 비동기 방식(callback)으로 초기화합니다.
| Parameters | |
|---|---|
application: Application | Application |
syncConfigsProvider: SyncConfigsProvider | SyncDatabase 초기화에 필요한 정보를 제공하는 Provider입니다. Provider는 프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 초기화 정보를 구성하고 제공합니다. |
databaseListener: DatabaseListener | 비동기 방식으로 진행된 SyncDatabase 초기화 결과 및 SyncDatabase의 상태에 대한 정보를 전달 받을 수 있는 Listener입니다. |
getInstance()
getInstance(databaseName: String)
해당 database와 연결된 SyncDatabase의 instance를 반환합니다.
| Parameters | |
|---|---|
databaseName: String | 접근하려는 database의 이름으로, Playground에서 신청할 때 입력한 이름입니다. |
| Returns | |
|---|---|
| SyncDatabase? | 해당 database와 연결된 SyncDatabase의 instance입니다. |
dispose()
fun dispose()
SyncDatabase의 모든 연결과 리소스를 정리하며 더 이상 SyncDatabase 및 SyncDocument를 사용할 수 없습니다.
Public functions
document()
@Throws(SyncException::class)
fun document(documentName: String): SyncDocument
해당 database의 document를 반환합니다.
| Parameters | |
|---|---|
documentName: String | 사용하려는 document 이름 |
| Returns | |
|---|---|
| SyncDocument | 해당 document를 표현하는 SyncDocument 객체 |
document 이름의 길이는 최소 2 bytes에서 최대 200 bytes까지입니다.
SyncDatabase에 접근할 수 있는 entry point이며 초기화 이후 getInstance()를 호출하여, 해당 database와 연결된 SyncDatabase의 instance를 가져올 수 있습니다. SyncDatabase에 있는 document를 읽고 쓰려면 document()를 사용하세요.
Summary
| Public static methods | |
|---|---|
| InitializationState | SyncDatabase SyncDatabase를 동기 방식으로 초기화합니다. |
void | SyncDatabase SyncDatabase를 비동기 방식(callback)으로 초기화합니다. |
| SyncDatabase | SyncDatabase 해당 database와 연결된 SyncDatabase의 instance를 반환합니다. |
void | SyncDatabase의 모든 연결과 리소스를 정리합니다. |
| Public methods | |
|---|---|
| SyncDocument | 해당 database의 document를 반환합니다. |
Public static methods
initialize()
initialize(@NonNull Application application, @NonNull SyncConfigsProvider syncConfigsProvider)
SyncDatabase를 동기방식으로 초기화합니다.
| Parameters | |
|---|---|
@NonNull Application application | Application |
@NonNull SyncConfigsProvider syncConfigsProvider | SyncDatabase 초기화에 필요한 정보를 제공하는 Provider입니다. Provider는 프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 초기화 정보를 구성하고 제공합니다. |
| Returns | |
|---|---|
| InitializationState | 각 database의 초기화 상태 및 그에 영향을 미친 정보를 제공하는 map 형태의 데이터 구조입니다. |
initialize()
initialize(@NonNull Application application, @NonNull SyncConfigsProvider syncConfigsProvider, @NonNull DatabaseListener listener)
SyncDatabase를 비동기 방식(callback)으로 초기화합니다.
| Parameters | |
|---|---|
@NonNull Application application | Application |
@NonNull SyncConfigsProvider syncConfigsProvider | SyncDatabase 초기화에 필요한 정보를 제공하는 Provider입니다. Provider는 프로젝트의 assets 폴더에 위치하고 있는 Playground에서 다운로드한 config 파일을 분석하여 초기화 정보를 구성하고 제공합니다. |
@NonNull DatabaseListener databaseListener | 비동기 방식으로 진행된 SyncDatabase 초기화 결과 및 SyncDatabase의 상태에 대한 정보를 전달 받을 수 있는 Listener입니다. |
getInstance()
getInstance(@NonNull String databaseName)
해당 database와 연결된 SyncDatabase의 instance를 반환합니다.
| Parameters | |
|---|---|
@Nullable String databaseName | 접근하려는 database의 이름으로, Playground에서 신청할 때 입력한 이름입니다. |
| Returns | |
|---|---|
| SyncDatabase | 해당 database와 연결된 SyncDatabase의 instance입니다. |
dispose()
void dispose()
SyncDatabase의 모든 연결과 리소스를 정리하며 더 이상 SyncDatabase 및 SyncDocument를 사용할 수 없습니다.
Public methods
document(@NonNull String documentName)
SyncDocument document(@NonNull String documentName) throws SyncException
해당 database의 document를 반환합니다.
| Parameters | |
|---|---|
@NonNull String documentName | 사용하려는 document 이름 |
| Returns | |
|---|---|
| SyncDocument | 해당 document를 표현하는 SyncDocument 객체 |
document 이름의 길이는 최소 2 bytes에서 최대 200 bytes까지입니다.