API Docs for:
Show:

NCMB.Role Class

Defined in: lib/role.js:7

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

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

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

Constructor

NCMB.Role

(
  • roleName
  • attrs
)

Defined in lib/role.js:7

Parameters:

  • roleName String

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

  • attrs Object

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

Methods

addRole

(
  • object
)

Defined in lib/role.js:183

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

Parameters:

  • object ncmb.Role

    追加する子ロール

Returns:

this

addUser

(
  • object
)

Defined in lib/role.js:175

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

Parameters:

  • object ncmb.User

    追加するユーザ

Returns:

this

delete

(
  • callback
)

Defined in lib/role.js:151

ロールを削除します。

Parameters:

  • callback Function

    コールバック関数

Returns:

true

fetchRole

(
  • callback
)
Array

Defined in lib/role.js:215

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

Parameters:

  • callback Function

    コールバック関数

Returns:

Array:

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

fetchUser

(
  • callback
)
Array

Defined in lib/role.js:207

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

Parameters:

  • callback Function

    コールバック関数

Returns:

Array:

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

removeRole

(
  • object
)

Defined in lib/role.js:199

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

Parameters:

  • object ncmb.Role

    削除する子ロール

Returns:

this

removeUser

(
  • object
)

Defined in lib/role.js:191

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

Parameters:

  • object ncmb.User

    削除するユーザ

Returns:

this

save

(
  • callback
)

Defined in lib/role.js:78

ロールを保存します。

Parameters:

  • callback Function

    コールバック関数

Returns:

this

update

(
  • callback
)

Defined in lib/role.js:110

ロールを更新します。

Parameters:

  • callback Function

    コールバック関数

Returns:

this