API Docs for:
Show:

NCMB.Role Class

Extends Operation
Defined in: lib/role.js:7

ロールについて扱うクラスです。

ユーザや他のロール（子ロール）をまとめて権限管理を行うことができます。 ユーザおよび子ロールの追加・削除はsave/update完了時に反映されます。

ロールへのユーザもしくは子ロールの追加と削除を同時に行うことはできません。 追加・削除の設定を行い、保存前に他方を設定した場合、後に行った処理が上書きされます。

※注意： ２種類のメソッド（インスタンスメソッド Instance method とスタティックメソッド Static method）があります。 それぞれリファレンス上の表記と利用時のメソッドが異なりますので、下記を参考にご利用ください。

  • リファレンス上の表記が「NCMB.Role#メソッド名」: インスタンスメソッド Instance method
    • 利用例）NCMB.Role#addUser
    var freePlanRole = new ncmb.Role("freePlan");
freePlanRole.addUser(user);
  • リファレンス上の表記が「NCMB.RoleConstructor#メソッド名」: スタティックメソッド Static method
    • Roleの場合は、お客様に提供するスタティックメソッドはありません。

Methods

NCMB.Role#addRole

(
  • object
)
This

Defined in lib/role.js:196

ロールに子ロールを追加します。

Parameters:

  • object Role | Array

    追加する子ロール

Returns:

This:

NCMB.Role#addUser

(
  • object
)
This

Defined in lib/role.js:188

ロールにユーザを追加します。

Parameters:

  • object User | Array

    追加するユーザ

Returns:

This:

NCMB.Role#delete

(
  • [callback]
)
Promise

Defined in lib/role.js:164

ロールを削除します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.Role#fetchRole

(
  • [callback]
)
Promise>

Defined in lib/role.js:228

ロールに登録されている子ロールの一覧を取得します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise>:

子ロールインスタンスの配列

NCMB.Role#fetchUser

(
  • [callback]
)
Promise>

Defined in lib/role.js:220

ロールに登録されているユーザの一覧を取得します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise>:

ユーザインスタンスの配列

NCMB.Role#removeRole

(
  • object
)
This

Defined in lib/role.js:212

ロールから子ロールを削除します。

Parameters:

  • object Role

    削除する子ロール

Returns:

This:

NCMB.Role#removeUser

(
  • object
)
This

Defined in lib/role.js:204

ロールからユーザを削除します。

Parameters:

  • object User

    削除するユーザ

Returns:

This:

NCMB.Role#save

(
  • [callback]
)
Promise

Defined in lib/role.js:91

ロールを保存します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.Role#update

(
  • [callback]
)
Promise

Defined in lib/role.js:123

ロールを更新します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.RoleConstructor#new

(
  • roleName
  • [attrs]
)
NCMB.Role

Defined in lib/role.js:265

Parameters:

  • roleName String

    ロール名。インスタンス生成時に必須

  • [attrs] Object optional

    インスタンス生成時に設定するプロパティ

Returns:

NCMB.Role: