Docs Home

/ /

io.realm.mongodb.sync

Docs Home

/ /

API 참조

io.realm.mongodb.sync

io.realm.mongodb.sync

클래스 동기화 구성

Atlas Device SDK는 더 이상 사용되지 않습니다. 자세한 내용은 지원 중단 페이지 를 참조하세요.

io.realm.mongodb.sync

java.lang.Object

io.realm.RealmConfiguration

io.realm.mongodb.sync.SyncConfiguration

SyncConfiguration 은 MongoDB Realm 을 사용하여 장치 간에 동기화할 수 있는 영역 을 설정 하는 데 사용됩니다.

SyncConfiguration 을 만들려면 유효한 사용자 가 필요합니다. 사용자 객체를 가져오는 방법에 대한 자세한 내용은 Credentials 및 App.loginAsync(Credentials, App.Callback) 를 참조하세요.

최소 SyncConfiguration 은 아래에서 찾을 수 있습니다.

App app = new App("app-id");
User user = app.login(Credentials.anonymous());
SyncConfiguration config = SyncConfiguration.defaultConfiguration(user, "partition-value");
Realm realm = Realm.getInstance(config);

동기화된 Realm은 자동으로 감지되고 수행될 수 있는 추가 마이그레이션만 지원하므로 다음 빌더 옵션은 일반 Realm에 비해 액세스할 수 없습니다.

deleteRealmIfMigrationNeeded()
migration(Migration)

동기화된 Realm은 Realm.getInstance(RealmConfiguration) 및 Realm.getDefaultInstance() 동기화되지 않은 일반적인 Realm과 같습니다.

팁

Docs 동기화에 대한 자세한 내용은 를 참조하세요.

중첩된 클래스 요약

수정자 및 유형	클래스 및 설명
`public static interface`	SyncConfiguration.InitialFlexibleSyncSubscriptions
`public static final`	SyncConfiguration.Builder

메서드 요약

수정자 및 유형	메서드 및 설명
공개 정적 SyncConfiguration	defaultConfig ( User user, ObjectId partitionValue ) 지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다.
공개 정적 SyncConfiguration	defaultConfig ( User user, Integer partitionValue ) 지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다.
공개 정적 SyncConfiguration	defaultConfig ( User user, Long partitionValue ) 지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다.
공개 정적 SyncConfiguration	defaultConfig ( User user, String partitionValue ) 지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다.
공개 정적 SyncConfiguration	defaultConfig ( User user ) 지정된 사용자에 대한 기본 Flexible Sync 구성을 반환합니다.
공개 부울	equals ( Object o )
public static RealmConfiguration	forRecovery ( String canonicalPath ) 읽기 전용의 동기화되지 않은 Realm 을 열어 보류 중인 변경 사항을 복구하기에 적합한 RealmConfiguration 을 반환합니다.
public static RealmConfiguration	forRecovery ( String canonicalPath, byte[] encryptionKey, java.lang.Object[] modules ) 읽기 전용의 동기화되지 않은 Realm 을 열어 보류 중인 변경 사항을 복구하기에 적합한 RealmConfiguration 을 반환합니다.
public SyncSession.ClientResetHandler	getClientResetHandler () 이 SyncConfiguration 에 대한 클라이언트 재설정 핸들러를 반환합니다.
공개 SyncSession.ErrorHandler	getErrorHandler () 이 SyncConfiguration 에 대한 오류 핸들러를 반환합니다.
보호된 Realm.Transaction	getInitialDataTransaction () 초기 데이터가 있는 트랜잭션 인스턴스를 반환합니다.
public long	getInitialRemoteDataTimeout ( TimeUnit unit ) Realm을 처음 열 때 초기 데이터를 다운로드할 때 정의된 시간 제한을 반환합니다.
public SyncConfiguration.InitialFlexibleSyncSubscriptions	getInitialSubscriptionsHandler () 이 Realm에 대해 구성된 초기 구독 핸들러를 반환합니다.
public BsonValue	getPartitionValue () 이 Realm이 분할된 값을 반환합니다.
공개 URI	getServerUrl () 로컬 Realm이 동기화 중인 원격 MongoDB Realm의 서버 URI를 반환합니다.
public OsRealmConfig.SyncSessionStopPolicy	getSessionStopPolicy () 참고: 내부용으로만 사용합니다.
공개 SyncClientResetStrategy	getSyncClientResetStrategy () 이 SyncConfiguration 에 대한 동기화 클라이언트 재설정 전략을 반환합니다.
공개 문자열	getUrlPrefix () Realm 객체 서버에 대한 동기화 연결을 설정할 때 사용되는 URL 접두사를 반환합니다.
공개 사용자	getUser () 사용자를 반환합니다.
public int	hashCode ()
공개 부울	isFlexibleSyncConfiguration () 이 구성이 Flexible Sync를 위해 구성된 Realm을 열기 위한 것인지 여부를 반환합니다.
공개 부울	isPartitionBasedSyncConfiguration () 이 구성이 파티션 기반 동기화를 위해 구성된 Realm을 열기 위한 것인지 여부를 반환합니다.
보호된 부울	isSyncConfiguration ()
보호된 부울	realmExists () 이 구성으로 정의된 Realm 파일이 이미 존재하는지 확인합니다.
공개 부울	shouldDeleteRealmOnLogout () Realm 파일을 소유한 사용자 가 로그아웃한 후 Realm 파일 을 삭제해야 하는 경우 `true` 를 반환합니다.
공개 부울	shouldWaitForInitialRemoteData () Realm이 처음 열리기 전에 원격 서버에서 알려진 모든 변경 사항을 다운로드하는 경우 `true` 를 반환합니다.
공개 문자열	toString ()

상속된 메서드

클래스 java.lang.Object에서 상속된 메서드: getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize
io.realm.RealmConfiguration 클래스에서 상속된 메서드: getRealmDirectory , getRealmFileName , getEncryptionKey , getSchemaVersion , getMigration , shouldDeleteRealmIfMigrationNeeded , getDurability , getSchemaMediator , getInitialDataTransaction , hasAssetFile , getAssetFilePath , getCompactOnLaunchCallback , getRealmObjectClasses , getPath , realmExists , getRxFactory , getFlowFactory , isReadOnly , isRecoveryConfiguration , getMaxNumberOfActiveVersions , isAllowWritesOnUiThread , isAllowQueriesOnUiThread , equals , getInstance , hashCode , createSchemaMediator , toString , isSyncConfiguration , forRecovery

메서드 세부 정보

defaultConfig

public static SyncConfiguration defaultConfig ( User user, ObjectId partitionValue )
지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다. 매개변수 `user` - Realm 앱에 액세스하는 데 사용할 사용자입니다. `partitionValue` - 동기화될 원격 Realm을 식별하는 파티션 값입니다. 반환 지정된 사용자 및 파티션 값에 대한 기본 구성입니다.

public static SyncConfiguration defaultConfig ( User user, Integer partitionValue )
지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다. 매개변수 `user` - Realm 앱에 액세스하는 데 사용할 사용자입니다. `partitionValue` - 동기화될 원격 Realm을 식별하는 파티션 값입니다. 반환 지정된 사용자 및 파티션 값에 대한 기본 구성입니다.

public static SyncConfiguration defaultConfig ( User user, Long partitionValue )
지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다. 매개변수 `user` - Realm 앱에 액세스하는 데 사용할 사용자입니다. `partitionValue` - 동기화될 원격 Realm을 식별하는 파티션 값입니다. 반환 지정된 사용자 및 파티션 값에 대한 기본 구성입니다.

public static SyncConfiguration defaultConfig ( User user, String partitionValue )
지정된 사용자 및 파티션 값에 대한 기본 파티션 기반 동기화 구성을 반환합니다. 매개변수 `user` - Realm 앱에 액세스하는 데 사용할 사용자입니다. `partitionValue` - 동기화될 원격 Realm을 식별하는 파티션 값입니다. 반환 지정된 사용자 및 파티션 값에 대한 기본 구성입니다.

public static SyncConfiguration defaultConfig ( User user )
지정된 사용자에 대한 기본 Flexible Sync 구성을 반환합니다. 매개변수 `user` - Realm 앱에 액세스하는 데 사용할 사용자입니다. 반환 지정된 사용자에 대한 기본 Flexible Sync 구성입니다. 팁 Flexible Sync에 대한 자세한 내용은 {@link SubscriptionSet}를 참조하세요.

같음

public boolean equals ( Object o )
재정의 `equals` RealmConfiguration클래스 내

for Recovery

public static RealmConfiguration forRecovery (

String canonicalPath

)

읽기 전용의 동기화되지 않은 Realm을 열어 보류 중인 변경 사항을 복구하기에 적합한 RealmConfiguration 을 반환합니다. 이 기능은 클라이언트 재설정 후 백업/복구 Realm을 열려고 할 때 유용합니다. 참고: 여기서는 기본 Realm 모듈(모든 RealmModel 로 구성됨)을 사용하며 암호화도 사용하지 않아야 한다고 가정합니다.

매개변수

canonicalPath - 이 구성으로 정의된 Realm 파일의 절대 경로입니다.

반환

오프라인에서 사용할 수 있는 RealmConfiguration

public static RealmConfiguration forRecovery (

String  canonicalPath,
byte[] encryptionKey,
java.lang.Object[]  modules

)

읽기 전용의 동기화되지 않은 Realm을 열어 보류 중인 변경 사항을 복구하기에 적합한 RealmConfiguration 을 반환합니다. 이 기능은 클라이언트 재설정 후 백업/복구 Realm을 열려고 할 때 유용합니다.

매개변수

canonicalPath - 이 구성으로 정의된 Realm 파일의 절대 경로입니다.
encryptionKey - Realm 파일을 암호화/복호화하는 데 사용되는 키입니다.
modules - 지정하면 Realm 스키마를 제공된 모듈로 제한합니다.

반환

오프라인에서 사용할 수 있는 RealmConfiguration

getClientResetHandler

public SyncSession.ClientResetHandler getClientResetHandler ()
이 SyncConfiguration 에 대한 클라이언트 재설정 핸들러를 반환합니다. 반환 클라이언트 재설정 처리기.

getErrorHandler

public SyncSession.ErrorHandler getErrorHandler ()
이 SyncConfiguration 에 대한 오류 핸들러를 반환합니다. 반환 오류 처리기.

getInitialDataTransaction

protected Realm.Transaction getInitialDataTransaction ()
초기 데이터가 있는 트랜잭션 인스턴스를 반환합니다. 반환 초기 데이터 트랜잭션. 재정의 `getInitialDataTransaction` RealmConfiguration클래스 내

getInitialRemoteDataTimeout

public long getInitialRemoteDataTimeout (

TimeUnit unit

)

Realm 을 처음 열 때 초기 데이터를 다운로드할 때 정의된 시간 제한을 반환합니다. 이 값은 shouldWaitForInitialRemoteData()가 true를 반환하는 경우에만 적용됩니다.

반환

Realm이 중단되고 예외가 발생하기 전에 모든 변경 사항이 다운로드될 때까지 기다리는 시간입니다.

팁

SyncConfiguration.Builder.waitForInitialRemoteData(long, TimeUnit)

getInitialSubscriptionsHandler

public SyncConfiguration.InitialFlexibleSyncSubscriptions getInitialSubscriptionsHandler ()
이 Realm에 대해 구성된 초기 구독 핸들러를 반환합니다. 반환 이 영역에 대한 초기 구독을 구성하는 데 사용되는 핸들러입니다.

getPartitionValue

public BsonValue getPartitionValue ()

이 Realm이 분할된 값을 반환합니다. 파티션 키는 MongoDB Realm에 정의된 속성입니다. 이 값의 속성이 있는 모든 클래스가 Realm과 동기화됩니다.

반환

서버 측 MongoDB Database를 독립적으로 동기화할 수 있는 Realm으로 분할하기 위해 MongoDB Realm에서 사용하는 값입니다.

스로우

불법적인 상태예외(IllegalStateException) - 이 구성이 유연한 동기화 위해 구성된 영역 에 대한 것인 경우. 이 메서드를 호출하기 전에 isPartitionBasedSyncConfiguration()을 사용하여 확인할 수 있습니다.

getServerUrl

public URI getServerUrl ()
로컬 Realm이 동기화 중인 원격 MongoDB Realm의 서버 URI를 반환합니다. 반환 이 로컬 Realm 동기화되는 MongoDB Realm 식별하는URI입니다.

getSessionStopPolicy

public OsRealmConfig.SyncSessionStopPolicy getSessionStopPolicy ()
참고: 내부용으로만 사용합니다. 예고 없이 변경될 수 있습니다. Realm이 닫히면 이 Realm의 세션에 대한 중지 정책을 반환합니다. 반환 Realm이 닫힌 후 세션에서 사용하는 중지 정책입니다.

getSyncClientResetStrategy

public SyncClientResetStrategy getSyncClientResetStrategy ()
이 SyncConfiguration 에 대한 동기화 클라이언트 재설정 전략을 반환합니다. 반환 동기화 클라이언트 재설정 전략.

getUrlPrefix

public String getUrlPrefix ()
Realm 객체 서버에 대한 동기화 연결을 설정할 때 사용되는 URL 접두사를 반환합니다.

getUser

public User getUser ()
사용자를 반환합니다. 반환 사용자.

해시 코드

public int hashCode ()
재정의 `hashCode` RealmConfiguration클래스 내

isFlexibleSyncConfiguration

public boolean isFlexibleSyncConfiguration ()
이 구성이 Flexible Sync를 위해 구성된 Realm을 열기 위한 것인지 여부를 반환합니다. 반환 `true` 이 구성이 Flexible Sync Realm에 대한 경우 그렇지 않은 경우 `false` 입니다.

isPartitionBasedSyncConfiguration

public boolean isPartitionBasedSyncConfiguration ()
이 구성이 파티션 기반 동기화를 위해 구성된 Realm을 열기 위한 것인지 여부를 반환합니다. 반환 `true` 이 구성이 파티션 기반 동기화 Realm에 대한 경우 그렇지 않은 경우 `false` 입니다.

isSyncConfiguration

protected boolean isSyncConfiguration ()
재정의 `isSyncConfiguration` RealmConfiguration클래스 내

realmExists

protected boolean realmExists ()

이 구성으로 정의된 Realm 파일이 이미 존재하는지 확인합니다.경고: 이 메서드는 특정 시점의 확인에 불과합니다. 외부 동기화로 보호되지 않는 한 이 메서드가 반환된 직후 다른 스레드나 프로세스가 Realm 파일을 생성하거나 삭제했을 수 있습니다.

반환

true Realm 파일이 있으면 false 를 반환합니다.

재정의

realmExists RealmConfiguration클래스 내

shouldDeleteRealmOnLogout

public boolean shouldDeleteRealmOnLogout ()
Realm 파일을 소유한 사용자 가 로그아웃한 후 Realm 파일 을 삭제해야 하는 경우 `true` 를 반환합니다. 반환 `true` 사용자 가 로그아웃한 경우 Realm 파일 을 삭제해야 하는 경우 파일 이 뒤에 남아 있도록 허용된 경우 `false` 입니다.

shouldWaitForInitialRemoteData

public boolean shouldWaitForInitialRemoteData ()
Realm이 처음 열리기 전에 원격 서버에서 알려진 모든 변경 사항을 다운로드하는 경우 `true` 를 반환합니다. 반환 `true` Realm이 열리기 전에 모든 원격 변경 사항이 다운로드되는지 여부 Realm을 즉시 열 수 있는 경우 `false` 입니다.

toString

public String toString ()
재정의 `toString` RealmConfiguration클래스 내

돌아가기

SyncClientResetStrategy

SyncConfiguration.Builder