カスタムフィールド

開発者は、既定フィールドに加え、任意のフィールド（年齢、性別、誕生日等）を追加できます。ただし、SDK により予約されているフィールド名は使用できません。予約されているフィールド名については appledoc を参照してください。

カスタムフィールドは UserFields インスタンスに設定してください。

カスタムフィールドの設定と変更

ユーザーのカスタムフィールドを設定・変更する例を以下に挙げます。

Swift:

// Set custom fields.
let userFields = KiiUserFields()
userFields.setObject(NSNumber(value: 20 as Int32), forKey: "age")
userFields.setObject("male", forKey: "gender")
userFields.setObject(NSNumber(value: 170.5 as Float), forKey: "height")
userFields.setObject(NSNumber(value: true as Bool), forKey: "isMember")

// Remove custom fields.
userFields.removeFromServer(forKey: "weight")
userFields.removeFromServer(forKey: "chest")

// Get the currently logged-in user.
let user = KiiUser.current()!

do {
  // Update the user attributes.
  try user.update(withUserFieldsSynchronous: userFields)
} catch let error as NSError {
  // Handle the error.
  return
}

// Set custom fields.
let userFields = KiiUserFields()
userFields.setObject(NSNumber(value: 20 as Int32), forKey: "age")
userFields.setObject("male", forKey: "gender")
userFields.setObject(NSNumber(value: 170.5 as Float), forKey: "height")
userFields.setObject(NSNumber(value: true as Bool), forKey: "isMember")

// Remove custom fields.
userFields.removeFromServer(forKey: "weight")
userFields.removeFromServer(forKey: "chest")

// Get the currently logged-in user.
let user = KiiUser.current()!

// Update the user attributes.
user.update(with: userFields) { (retUser :KiiUser?, error : Error?) -> Void in
  if error != nil {
    // Handle the error.
    return
  }
}

Objective-C:

// Set custom fields.
KiiUserFields *userFields = [[KiiUserFields alloc] init];
[userFields setObject:[NSNumber numberWithInt:20] forKey:@"age"];
[userFields setObject:@"male" forKey:@"gender"];
[userFields setObject:[NSNumber numberWithFloat:170.5f] forKey:@"height"];
[userFields setObject:[NSNumber numberWithBool:YES] forKey:@"isMember"];

// Remove custom fields.
[userFields removeFromServerForKey:@"weight"];
[userFields removeFromServerForKey:@"chest"];

NSError *error = nil;

// Get the currently logged-in user.
KiiUser *user = [KiiUser currentUser];

// Update the user attributes.
[user updateWithUserFieldsSynchronous:userFields error:&error];
if (error != nil) {
  // Handle the error.
  return;
}

// Set custom fields.
KiiUserFields *userFields = [[KiiUserFields alloc] init];
[userFields setObject:[NSNumber numberWithInt:20] forKey:@"age"];
[userFields setObject:@"male" forKey:@"gender"];
[userFields setObject:[NSNumber numberWithFloat:170.5f] forKey:@"height"];
[userFields setObject:[NSNumber numberWithBool:YES] forKey:@"isMember"];

// Remove custom fields.
[userFields removeFromServerForKey:@"weight"];
[userFields removeFromServerForKey:@"chest"];

// Get the currently logged-in user.
KiiUser *user = [KiiUser currentUser];

// Update the user attributes.
[user updateWithUserFields:userFields block:^(KiiUser *user, NSError *error) {
  if (error != nil) {
    // Handle the error.
    return;
  }
}];

既存のフィールドを更新対象として指定しない場合、そのフィールドはそのまま Kii Cloud 上に保持されます。

updateWithUserFields:block: メソッドが正常に完了すると、フィールドが Kii Cloud および KiiUser インスタンスで更新されます。

また既定フィールドとカスタムフィールドの設定・変更は同時に行えます。

ユーザー属性の変更は、基本的にログイン中のユーザー本人に対してのみ実行できます。詳しくはユーザー属性をご覧ください。

注意：[KiiUser saveSynchronous:] と [KiiUser save:withCallback:] は deprecated になりました。今後は [KiiUser updateWithIdentityDataSynchronous:userFields:error:], [KiiUser updateWithUserFieldsSynchronous:error], または [KiiUser updateWithIdentityData:userFields:block:], [KiiUser updateWithUserFields:block:], を利用してください。