ドキュメントTOP » API の解説 » Monaca API » バックエンド マネジメント API » コレクションアイテムの管理

コレクションアイテムの管理

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

メソッド

解説

CollectionItem.list()

コレクション内のアイテムの一覧を取得します。

CollectionItem.create()

コレクションアイテムを作成します。

CollectionItem.get()

コレクションアイテムを取得します。

CollectionItem.update()

コレクションアイテムを更新します。

CollectionItem.delete()

コレクションアイテムを削除します。

CollectionItem.getPermission()

コレクションアイテムのパーミッション ( 権限 ) を取得します。

CollectionItem.setPermission()

コレクションアイテムのパーミッション ( 権限 ) を設定します。

CollectionItem.list - コレクション内のアイテムの一覧を取得

コレクション内のアイテムの一覧を取得します。

CollectionItem.list

パラメーター
collectionName

文字列

コレクション名です。

page

数値

ページ番号 ( 1 から開始 ) です。

itemsInPage

数値

1 つのページに表示されるアイテムの数です。

sortProperty

文字列

ソート時に使用するプロパティーです。

sortOrder

文字列

ソート順には、 "asc" または "desc" ( デフォルトでは "asc" )が指定できます。

propertyNames

文字列

システムプロパティーに加え、追加で取得するプロパティーです。

戻り値
items

アイテムです。

totalItems

アイテム数です。

エラーコード

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

-32602

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

CollectionItem.create - コレクションアイテムの作成

コレクションアイテムを作成します。

CollectionItem.create

パラメーター
collectionName

文字列

コレクション名です。

item

オブジェクト

アイテムのデータです。

戻り値
item

_id を割り当てたアイテムのデータです。

エラーコード

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

-32602

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

CollectionItem.get - コレクションアイテムの取得

コレクションアイテムを取得します。

CollectionItem.get

パラメーター
collectionName

文字列

コレクション名です。

_id

文字列

アイテムの ID です。

戻り値
item

アイテムのデータです。

エラーコード

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

-32602

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

CollectionItem.update - コレクションアイテムの更新

コレクションアイテムを更新します。

CollectionItem.update

パラメーター
collectionName

文字列

コレクション名です。

_id

文字列

アイテムの ID です。

item

オブジェクト

アイテムのデータです ( _id 行と _permission 行は無視します )。

戻り値

なし

 
エラーコード

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

-32602

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

CollectionItem.delete - コレクションアイテムの削除

複数のコレクションアイテムを削除します。

CollectionItem.delete

パラメーター
collectionName

文字列

コレクション名です。

idList

配列

アイテム ID の一覧です。

戻り値

なし

 
エラーコード

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

-32602

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

CollectionItem.getPermission - コレクションアイテムのパーミッション ( 権限 ) の取得。

コレクションアイテムのパーミッション ( 権限 ) を取得します。

CollectionItem.getPermission

パラメーター
collectionName

文字列

コレクション名です。

_id

文字列

アイテムの ID です。

戻り値
permission

オブジェクト

パーミッション ( 権限 ) です。

エラーコード

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

-32602

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

CollectionItem.setPermission - コレクションアイテムのパーミッション ( 権限 ) の設定

コレクションアイテムのパーミッション ( 権限 ) を設定します。

CollectionItem.setPermission

パラメーター
collectionName

文字列

コレクション名です。

_id

文字列

アイテムの ID です。

permission

オブジェクト

新しいパーミッション ( 権限 ) です。

戻り値

なし

 
エラーコード

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

-32602

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