Entity Reference

Entitiy Reference

KiiUser

User ID

We call {UserID} segment User ID in this path.

下記のパスで、{UserID}の部分を User ID と呼びます。

/api/apps/{AppID}/users/{UserID}

We can use 'me' as User ID, This is the special User ID and represents token's owner.

'me' を User ID として使用することもできます。これは特殊な User ID で、 現在セットされているトークンの持ち主を表します。

Create KiiUser

If you already know User ID, you can create KiiUser object.

User ID を知っていれば、KiiUserオブジェクトは下記の手順で作成できます。

$id = 'myUserId';
$user = new KiiUser($id);

KiiGroup

Group ID

We call {GroupID} segment Group ID in this path.

下記のパスで、{GroupID}の部分を Group ID と呼びます。

/api/apps/{AppID}/groups/{GroupID}

Create KiiGroup

If you already know Group ID, you can create KiiGroup object.

Group ID を知っていれば、KiiGroupオブジェクトは下記の手順で作成できます。

$id = 'myGroupId';
$group = new KiiGroup($id);

KiiBucket

Bucket Name

We call {BucketName} segment Bucket Name in this path.

下記のパスで、{BucketName}の部分を Bucket Name と呼びます。

/api/apps/{AppID}/buckets/{BucketName}

Scope

Kii Cloud has 3 scopes. Scope defines the visibilities.

• Application : App user can access this entity.
• Group : Only Group member can access this entity.
• User : Only the specified member can access this entity.

Kii Cloudには3種類のスコープがあります。スコープとは可視性を定義するものです。

• アプリケーション : アプリユーザーなら誰でもアクセス可能
• グループ : グループのメンバーのみアクセス可能
• ユーザー : 指定したユーザーのみアクセス可能

Create KiiBucket

If you already have scope object and know Bucket Name, you can create KiiBucket object.

Scopeオブジェクトと、Bucket Name を知っていれば、KiiBucketオブジェクトは下記の手順で作成できます。

# user scope bucket (current user's scope)
$user = $api->login('username', 'password');

$name = 'inbox';
$bucket = new KiiBucket($user, name);

KiiObject

Object ID

We call {ObjectID} segment Object ID in this path.

下記のパスで、{ObjectID}の部分を Object ID と呼びます。

/api/apps/{AppID}/buckets/{BucketName}/objects/{ObjectID}

Create KiiObject

If you already have KiiBucket object and know Object ID, you can create KiiObject object.

KiiBucketオブジェクトと、Object ID を知っていれば、KiiObjectオブジェクトは下記の手順で作成できます。

# user scope object (current user's scope)
$user = $api->login('username', 'password');

$name = 'inbox';
$bucket = new KiiBucket($user, name);

$objId = 'myObjectId';
$data = array('name' => 'fkm');
$obj = new KiiObject($bucket, $objId, $data);

KiiTopic

KiiTopicMessage

Provides the data structure of Topic message.

KiiGCMMessage

Provides the data structure of Topic message for GCM.

KiiAPNsMessage

Provides the data structure of Topic message for APNs.