コレクションの管理

コレクションの管理に使用する Monaca バックエンド マネジメント API を、次に記します。

メソッド

解説

Collection.list()

コレクションの一覧を取得します。

Collection.create()

新しいコレクション オブジェクトを作成します。

Collection.drop()

コレクションを破棄します。

Collection.setConfig()

コレクションの設定を行ないます。

Collection.getConfig()

コレクションの設定情報を取得します。

Collection.getPropertyNames()

コレクションアイテムのプロパティー名を取得します。

Collection.list - コレクションの一覧を取得

コレクションの一覧を取得します。

Collection.list

パラメーター

なし

 
戻り値
items

配列

コレクションの定義です。

エラーコード
N/A  

Collection.create - コレクションの作成

新しいコレクション オブジェクトを作成します。

Collection.create

パラメーター
_id

文字列

コレクション名です。

isInsertable

真偽値

 
defaultPublicPermission

文字列

コレクションに適用する、すべてのユーザー向けのパーミッション ( 権限 ) です。 """r""w""rw" のいずれかとなります。

戻り値

なし

 
エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

Collection.drop - コレクションの削除

コレクションを削除します。

Collection.drop

パラメーター
_id

文字列

コレクション名です。

戻り値

なし

 
エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

Collection.setConfig - コレクションの設定

コレクションの設定を行います。

Collection.setConfig

パラメーター
_id

文字列

コレクション名です。

isInsertable

真偽値

 
defaultPublicPermission

文字列

コレクションに適用する、すべてのユーザー向けのパーミッション ( 権限 ) です。 """r""w""rw" のいずれかとなります。

戻り値

なし

 
エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

Collection.getConfig - コレクションの設定情報の取得

コレクションの設定情報を取得します。

Collection.getConfig

パラメーター
_id

文字列

コレクション名です。

戻り値
config

オブジェクト

コレクションの定義です。

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

Collection.getPropertyNames - コレクションアイテムのプロパティー名の取得

コレクションの最新 100 個のコレクションアイテムの中から、表示可 ( 読み込み可 ) となっているプロパティー名を取得します。

Collection.getPropertyNames

パラメーター
_id

文字列

コレクション名です。

戻り値
names

配列

プロパティー名の配列です。

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。