グループの参照
モバイルアプリからグループ内のデータを参照するには、以下の方法があります。
- ID によるグループの参照
- メンバーやオーナーのグループの参照
このページでは、ID を使ったグループの参照方法を説明します。2 つ目に示した、メンバーやオーナーとなっているグループを参照する方法は、グループ一覧によるグループの参照 で説明します。
グループの作成時に指定したグループ名では、既存グループを参照できません。参照しようとすると、同名の新しいグループが作成されます。
ここでは、ID からグループを参照する例を示します。
ID からグループを参照するには、グループの作成直後にそのグループの ID を取得し、ID をどこかに保存しておく必要があります。
ID の取得と保存
グループを作成した際、ログイン中のユーザーから参照できる場所に ID を保存しておきます。
この例では、ユーザースコープの
groupChatBucket
にある KiiObject に、ChatGroupID
というキーで ID の文字列を保存しています。Bucket を使わず、OS 依存のストレージ(Android の SharedPreference や、iOS の NSUserDefaults など)に保存することもできます。ID の取得
グループを参照する際には、
ChatGroupID
から ID を取得します。ID によるグループの参照
ID からグループを参照します。これにより、元の KiiGroup と同じグループをクライアント上に復元できます。
ID によるグループの参照
一度作成したグループは、グループ ID を使用して次のように参照します。
curl -v -X GET \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
"https://api-jp.kii.com/api/apps/{APP_ID}/groups/{GROUP_ID}"
グループは次のように 200 応答として返されます。
< 200 OK
< Content-Type: application/vnd.kii.GroupRetrievalResponse+json;charset=UTF-8
<
{
"groupID" : "{GROUP_ID}",
"name" : "{GROUP_NAME}",
"owner" : "{GROUP_OWNER_USER_ID}",
"createdAt" : {CREATED_DATE},
"modifiedAt" : {LAST_MODIFIED_DATE}
}