名前空間 Realm.Sync

クラス

apiKey

ユーザーの API キーを表すクラス。これは、通常の認証情報の代わりにログインするときにユーザーを表すために使用できます。これらのキーは、 ApiKeysを通じて作成または取得されます。
API キーの値は、キーが作成されたときにのみ使用でき、その後は取得できません。つまり、作成時に API キーの値を安全に保存するのは呼び出し元の責任です。

アプリ

アプリは、Atlas App Services アプリケーションを操作するためのクライアント側の主要エントリポイントです。

このアプリは、次の目的で使用できます。

使用状況を登録し、認証プロバイダー（例: ApiKeys 、 EmailPasswordAuth ）。
同期された Realm を使用して、ローカルデバイスとリモート Realm アプリ間でデータを同期します（ SyncConfigurationBaseを使用）。
関数を使用して Realm アプリの関数を呼び出します（関数を使用）。
MongoClient （ GetMongoClient(string)を使用）を使用して MongoDB データベースからリモートデータにアクセスします。

リモート Realm App にリンクするアプリを作成するには、Realm を初期化し、次のようにアプリを構成します。

var appConfig = new AppConfiguration("my-realm-app-id");
var app = new App(appConfig);

アプリを構成した後、ユーザーの管理を開始し、同期された Realm の構成、リモートRealm関数の呼び出し、 mongoコレクションを介してリモートデータにアクセスできます。
新しいユーザーを登録したり、既存のユーザーを使用してログインしたりするには、次の操作を行います。

await app.EmailPassword.RegisterUserAsync("foo@bar.com", "password");
// Login with existing user
var user = app.LoginAsync(Credentials.EmailPassword("foo@bar.com", "password");

承認されたユーザーの場合、次のようにSyncConfigurationBaseで Realm を開くことで、ローカルデバイスとリモート Realm アプリ間でデータを同期できます。

var syncConfig = new PartitionSyncConfiguration("some-partition-value", user);
using var realm = await Realm.GetInstanceAsync(syncConfig);
realm.Write(() =>
{
realm.Add(...);
});
await realm.GetSession().WaitForUploadAsync();

以下に示すように、リモート Realm 関数を呼び出すことができます。

var result = await user.Functions.CallAsync<int>("sum", 1, 2, 3, 4, 5);

以下に示すように、リモート Realm アプリからコレクションにアクセスします。

var client = user.GetMongoClient("atlas-service");
var db = client.GetDatabase("my-db");
var collection = db.GetCollection("foos");
var foosCount = await collection.CountAsync();

FlexibleSyncConfigurationは、Atlas Device Sync を使用してデバイス間でデータを同期できるRealmを設定するために使用されます。 partitionSyncConfiguration とは異なり、 FlexibleSyncConfiguration で開かれた Realm は、 1 つ以上のサブスクリプションがサブスクリプション経由で追加されるまで、最初は空の状態になります。

MongoClient

Realm 経由で MongoDB のデータをリモートで操作するために使用されるリモート MongoClient です。

MongoClient.Collection=TDocument><TDocument>

リモート MongoDB コレクションを表すオブジェクト。

MongoClient.Database

リモート MongoDB database を表すオブジェクト。

Flexible Configuration

FlexibleConfigurationは、Atlas Device Sync を使用してデバイス間で同期できるRealmを設定するために使用されます。

ReconnectBackupOptions

同期クライアントが使用する再接続遅延を構成するオプション。

セッション

同期セッションをカプセル化するオブジェクト。セッションは、クライアント（およびディスク上のローカル Realm ファイル）と MongoDB Atlas との間の通信を表します。セッションは常に SDK によって作成され、さまざまな API を通じて販売されます。 Realm に関連付けられたセッションの有効期限は自動的に管理されます。

サブスクリプション

1 つのクエリサブスクリプションを表すクラス。サーバーはアプリがサブスクライブしたクエリを継続的に評価し、それに一致するデータを送信し、不要なデータを削除します。

SubscriptionOptions

Add%:<T><T>このクラスのすべてのプロパティは任意です。

SubscriptionSet

Realmインスタンスのアクティブなサブスクリプションのセットを表すコレクション。これは、サーバーと同期するクエリのセットを宣言するために、 FlexibleSyncConfigurationと組み合わせて使用されます。サブスクリプションセットには自由にアクセスして読み取ることができますが、これをミューテーションするにはUpdate（アクション）ブロックが必要です。

SyncConfigurationBase

SyncConfigurationBaseは、Atlas Device Sync を使用してデバイス間で同期できるRealmを設定するために使用されます。同期モードには、それぞれの構成を持つ 2 つがあります。Flexible Sync との「パーティション」同期により、データを個別のパーティションに分割し、パーティション全体を Realm 全体と同期できます。 FlexibleSyncConfigurationと「柔軟」な同期を使用すると、空の Realm から開始し、サーバーに実行されるクエリのセットをサーバーに送信し、それに一致するすべてのドキュメントを Realm に入力します。

SyncTimeoutOptions

同期クライアントで使用されるタイムアウトと間隔を設定するオプション。

user

このクラスは、Atlas App Services アプリケーション内のユーザーを表します。認証情報は、さまざまなサードパーティプロバイダー（Facebook、Google など）によって提供されます。ユーザーはサーバーにログインでき、アクセス権が付与されていれば、ローカルとリモートの Realm を同期できます。さらに、ユーザーがログアウトすると同期は停止します。ユーザーを永続化することができます。ユーザーを取得しているため、サードパーティープロバイダーに再度ログインする必要はありません。セッション間でユーザーを保持すると、ユーザーの認証情報はデバイスのローカルに保存されるため、機密データとして扱われる必要があります。

委任

FlexibleSyncConfiguration.InitialSubscriptionsDelegate

柔軟な同期 Realm が最初に開かれたときに呼び出される委任。

SyncConfigurationBase.SessionErrorCallback

セッション内でエラーが発生したときにトリガーされるコールバック。

名前空間 Realm.Sync

クラス

構造体

Enums

委任