カスタムユーザーデータ - Swift SDK

項目一覧

ユーザーのカスタムデータの読み取り

ユーザーのカスタムデータドキュメントの作成
ユーザーのカスタムデータの更新

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

ユーザーのカスタムデータの読み取り

現在ログインしているユーザーのカスタムユーザーデータは、そのユーザーの Userオブジェクトから読み取ることができます。 Userオブジェクトを使用してカスタムユーザーデータを編集することはできません。カスタムユーザーデータを編集するには、「カスタムユーザーデータの更新」を参照してください。データを読み取るには、ログインユーザーのUserオブジェクトのcustomDataプロパティにアクセスします。

RLMApp *app = [RLMApp appWithId:YOUR_APP_ID];
[app loginWithCredential:[RLMCredentials anonymousCredentials] completion:^(RLMUser *user, NSError *error) {
    if (error != nil) {
        NSLog(@"Failed to log in: %@", error);
        return;
    }
    
    // If the user data has been refreshed recently, you can access the
    // custom user data directly on the user object
    NSLog(@"User custom data: %@", [user customData]);
    
    // Refresh the custom data
    [user refreshCustomDataWithCompletion:^(NSDictionary *customData, NSError *error) {
        if (error != nil) {
            NSLog(@"Failed to refresh custom user data: %@", error);
            return;
        }
        NSLog(@"Favorite color: %@", customData[@"favoriteColor"]);
    }];
}];

let appId = YOUR_APP_SERVICES_APP_ID // replace this with your App ID
let app = App(id: appId)
app.login(credentials: Credentials.anonymous) { (result) in
    switch result {
    case .failure(let error):
        print("Failed to log in: \(error.localizedDescription)")
    case .success(let user):
        // If the user data has been refreshed recently, you can access the
        // custom user data directly on the user object
        print("User custom data: \(user.customData)")
        // Refresh the custom user data
        user.refreshCustomData { (result) in
            switch result {
            case .failure(let error):
                print("Failed to refresh custom data: \(error.localizedDescription)")
            case .success(let customData):
                // favoriteColor was set on the custom data.
                print("Favorite color: \(customData["favoriteColor"] ?? "not set")")
                return
            }
        }
    }
}

警告

カスタムデータは古い可能性があります

Atlas App Services は、基礎となるデータが変更されたときにすぐに、クライアント側のユーザーカスタムデータドキュメントの値を動的に更新しません。代わりに、ユーザーがアクセストークンを更新するたびに、App Services は最新バージョンのカスタムユーザーデータを取得します。このトークンは App Services バックエンドにアクセスするほとんどの SDK 操作で使用されます。トークンがデフォルトの30分の有効期限前に更新されない場合、Swift SDK はバックエンドに対する次回の呼び出しでトークンを更新します。カスタムユーザーデータは、最大30分、バックエンドへの次の SDK 呼び出しが発生するまでの時間古くなる可能性があります。

注意

最新バージョンのカスタムユーザーデータが必要な場合は、 refreshCustomDataWithCompletionメソッドを使用して、ユーザーのカスタムデータの最新バージョンをリクエストしてください。

ユーザーのカスタムデータドキュメントの作成

ユーザーのカスタムユーザーデータを作成するには、カスタムユーザーデータコレクションに MongoDB ドキュメントを作成します。ドキュメントのユーザー ID フィールドには、ユーザーのユーザー ID が含まれている必要があります。

Tip

Atlas App Services UI で、 Custom User Dataタブの下の App Usersページを確認して、次のようなカスタムユーザーデータ設定を検索して構成します。

カスタムユーザーデータクラスター、データベース、コレクション
カスタムユーザーデータドキュメントをユーザーにマッピングするために使用されるユーザーID フィールド

次の例では、 MongoDBリモートアクセスを使用して、現在ログインしているユーザーのユーザー ID とfavoriteColor値を含むドキュメントをカスタムユーザーデータコレクションに挿入します。

RLMApp *app = [RLMApp appWithId:YOUR_APP_ID];
[app loginWithCredential:[RLMCredentials anonymousCredentials] completion:^(RLMUser *user, NSError *error) {
    if (error != nil) {
        NSLog(@"Failed to log in: %@", error);
        return;
    }
    RLMMongoClient *client = [user mongoClientWithServiceName:@"mongodb-atlas"];
    RLMMongoDatabase *database = [client databaseWithName:@"my_database"];
    RLMMongoCollection *collection = [database collectionWithName:@"users"];
    [collection insertOneDocument:
        @{@"userId": [user identifier], @"favoriteColor": @"pink"}
        completion:^(id<RLMBSON> newObjectId, NSError *error) {
            if (error != nil) {
                NSLog(@"Failed to insert: %@", error);
            }
            NSLog(@"Inserted custom user data document with object ID: %@", newObjectId);
    }];
}];

let appId = YOUR_APP_SERVICES_APP_ID // replace this with your App ID
let app = App(id: appId)
app.login(credentials: Credentials.anonymous) { (result) in
    switch result {
    case .failure(let error):
        print("Failed to log in: \(error.localizedDescription)")
    case .success(let user):
        let client = user.mongoClient("mongodb-atlas")
        let database = client.database(named: "my_database")
        let collection = database.collection(withName: "users")
        // Insert the custom user data object
        collection.insertOne([
            "userId": AnyBSON(user.id),
            "favoriteColor": "pink"
            ]) { (result) in
            switch result {
            case .failure(let error):
                print("Failed to insert document: \(error.localizedDescription)")
            case .success(let newObjectId):
                print("Inserted custom user data document with object ID: \(newObjectId)")
            }
        }
    }
}

カスタムユーザーデータドキュメントの作成時に、任意の数のフィールドと値を追加できます。ユーザー ID フィールドは、ドキュメントがカスタムユーザーデータとしてUserオブジェクトで使用可能になるための唯一の要件です。

ユーザーのカスタムデータの更新

MongoDB Data Access 、 Atlas Device Sync 、 MongoDB Compass 、またはMongoDB Atlas Data Explorer を使用して、カスタムユーザーデータをアップデートできます。

MongoDB Data Access を使用してユーザーのカスタムユーザーデータを更新するには、ユーザーのユーザー ID がユーザーのユーザー ID フィールドに含まれる MongoDB ドキュメントを編集します。次の例ではMongoDB Data Accessを使用して、カスタムユーザーデータコレクション内の現在ログインしているユーザーのユーザー ID を含むドキュメントのfavoriteColorフィールドを更新します。

RLMApp *app = [RLMApp appWithId:YOUR_APP_ID];
[app loginWithCredential:[RLMCredentials anonymousCredentials] completion:^(RLMUser *user, NSError *error) {
    if (error != nil) {
        NSLog(@"Failed to log in: %@", error);
        return;
    }
    RLMMongoClient *client = [user mongoClientWithServiceName:@"mongodb-atlas"];
    RLMMongoDatabase *database = [client databaseWithName:@"my_database"];
    RLMMongoCollection *collection = [database collectionWithName:@"users"];
    // Update the user's custom data document
    [collection updateOneDocumentWhere:@{@"userId": [user identifier]}
        updateDocument: @{@"favoriteColor": @"cerulean"}
        completion:^(RLMUpdateResult *updateResult, NSError *error) { 
            if (error != nil) {
                NSLog(@"Failed to insert: %@", error);
            }
            NSLog(@"Matched: %lu, modified: %lu", [updateResult matchedCount], [updateResult modifiedCount]);
    }];
}];

let appId = YOUR_APP_SERVICES_APP_ID // replace this with your App ID
let app = App(id: appId)
app.login(credentials: Credentials.anonymous) { (result) in
    switch result {
    case .failure(let error):
        print("Failed to log in: \(error.localizedDescription)")
    case .success(let user):
        // Access the custom user document remotely to update it.
        let client = user.mongoClient("mongodb-atlas")
        let database = client.database(named: "my_database")
        let collection = database.collection(withName: "users")
        collection.updateOneDocument(
            filter: ["userId": AnyBSON(user.id)],
            update: ["favoriteColor": "cerulean"]
        ) { (result) in
            switch result {
            case .failure(let error):
                print("Failed to update: \(error.localizedDescription)")
                return
            case .success(let updateResult):
                // User document updated.
                print("Matched: \(updateResult.matchedCount), updated: \(updateResult.modifiedCount)")
            }
        }
    }
}

Tip

ユーザーの ID を確認するには、 App Users User.idプロパティにアクセスするか、App Services UI で [] ページの [ Users ] タブでユーザーを見つけます。

戻る

ユーザーの認証

ユーザーメタデータ

ユーザーのカスタム データの読み取り

警告

カスタム データは古い可能性があります

注意

ユーザーのカスタム データ ドキュメントの作成

Tip

ユーザーのカスタム データの更新

Tip

ユーザーのカスタムデータの読み取り

カスタムデータは古い可能性があります

ユーザーのカスタムデータドキュメントの作成

ユーザーのカスタムデータの更新