NbGroup (モバイルバックエンド基盤 Java / Android SDK リファレンス)

java.lang.Object
- com.nec.baas.user.NbGroup

```
public class NbGroup
extends java.lang.Object
```
グループ情報の管理を行うクラス。
本クラスのインスタンスはスレッドセーフではない。

導入されたバージョン:

1.0

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`NbGroup(NbService service, java.lang.String groupName)` グループインスタンスを新規生成する
`NbGroup(java.lang.String groupName)` グループインスタンスを新規生成する(マルチテナント非対応)

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`static void`	`__resetNebulaService()`
`NbService`	`_getService()`
`NbGroup`	`addGroup(NbGroup group)` グループに所属するグループを追加する。
`NbGroup`	`addGroup(java.lang.String group)` グループに所属するグループを追加する。
`NbGroup`	`addUser(NbUser user)` グループに所属するユーザを追加する。
`NbGroup`	`addUser(java.lang.String userId)` グループに所属するユーザを追加する。
`void`	`delete(NbResultCallback callback)` グループの削除を行う。
`NbAcl`	`getAcl()` グループのACLを取得する。
`java.lang.String`	`getCreatedTime()` グループが作成された時間を取得する。
`java.lang.String`	`getETag()` グループのETagを取得する。
`static void`	`getGroup(NbService service, java.lang.String groupName, NbCallback<NbGroup> callback)` 指定したグループの情報を取得する(マルチテナント非対応)。
`static void`	`getGroup(NbService service, java.lang.String groupName, NbGroupsCallback callback)` 非推奨です。 `getGroup(NbService, String, NbCallback)` で置き換え
`static void`	`getGroup(java.lang.String groupName, NbCallback<NbGroup> callback)` 指定したグループの情報を取得する(マルチテナント非対応)。
`static void`	`getGroup(java.lang.String groupName, NbGroupsCallback callback)` 非推奨です。 `getGroup(String, NbCallback)` で置き換え
`java.lang.String`	`getGroupName()` グループ名を取得する。
`java.util.List<java.lang.String>`	`getGroups()` グループに所属するグループの一覧を取得する。
`java.lang.String`	`getId()` グループのIDを取得する。
`java.lang.String`	`getUpdatedTime()` グループが更新された時間を取得する。
`java.util.List<java.lang.String>`	`getUsers()` グループに所属するユーザIDの一覧を取得する。
`static void`	`query(NbCallback<java.util.List<NbGroup>> callback)` グループ情報の一覧を取得する(マルチテナント非対応)。
`static void`	`query(NbService service, NbCallback<java.util.List<NbGroup>> callback)` グループ情報の一覧を取得する(マルチテナント対応)。
`NbGroup`	`removeGroup(NbGroup group)` グループに所属するグループを削除する。
`NbGroup`	`removeGroup(java.lang.String group)` グループに所属するグループを削除する。
`NbGroup`	`removeUser(NbUser user)` グループに所属するユーザを削除する。
`NbGroup`	`removeUser(java.lang.String userId)` グループに所属するユーザを削除する。
`void`	`save(NbCallback<NbGroup> callback)` グループの保存を行う。
`void`	`save(NbGroupsCallback callback)` 非推奨です。 `save(NbCallback)` で置き換え
`NbGroup`	`setAcl(NbAcl acl)` グループのACLを設定する。
`NbGroup`	`setETag(java.lang.String eTag)`
`NbGroup`	`setGroups(java.util.List<java.lang.String> groups)` グループに所属するグループの一覧を設定する。
`NbGroup`	`setUsers(java.util.List<java.lang.String> users)` グループに所属するユーザIDの一覧を設定する。
`NbJSONObject`	`toJsonObject()` NbGroup をグループの JSON 表現に変換する。

クラスから継承されたメソッド java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - NbGroup
```
public NbGroup(java.lang.String groupName)
```
    グループインスタンスを新規生成する(マルチテナント非対応)
    
    パラメータ:
    
    groupName - グループ名
  - NbGroup
```
public NbGroup(NbService service,
               java.lang.String groupName)
```
    グループインスタンスを新規生成する
    
    パラメータ:
    
    service - サービス
    
    groupName - グループ名
- メソッドの詳細
  - save
```
@Deprecated
public void save(NbGroupsCallback callback)
```
    非推奨です。 save(NbCallback) で置き換え
    
    グループの保存を行う。
  - save
```
public void save(NbCallback<NbGroup> callback)
```
    グループの保存を行う。
    グループ名に使用できる文字は半角英数字とアンダーバーのみとなる。
    グループ名の文字数上限は100文字となる。
    但し、authenticated、anonymousは予約語のため使用できない。
    グループの作成にはGROUPSバケットに対するcreate権限が必要となる。
    グループの変更にはGROUPSバケットおよび、対象グループのupdate権限が必要となる。
    また、ACLの変更を行う場合はオーナ権限もしくはadmin権限も必要となる。
    
    パラメータ:
    
    callback - 保存したグループを受け取るコールバック。
  - query
```
public static void query(NbCallback<java.util.List<NbGroup>> callback)
```
    グループ情報の一覧を取得する(マルチテナント非対応)。
    Groupバケットおよび対象グループのread権限が必要。
    
    パラメータ:
    
    callback - グループ一覧を取得するコールバック
    
    関連項目:
    
    NbGroupsCallback
  - query
```
public static void query(NbService service,
                         NbCallback<java.util.List<NbGroup>> callback)
```
    グループ情報の一覧を取得する(マルチテナント対応)。
  - getGroup
```
@Deprecated
public static void getGroup(java.lang.String groupName,
                                        NbGroupsCallback callback)
```
    非推奨です。 getGroup(String, NbCallback) で置き換え
    
    指定したグループの情報を取得する(マルチテナント非対応)。
    
    導入されたバージョン:
    
    1.0
  - getGroup
```
public static void getGroup(java.lang.String groupName,
                            NbCallback<NbGroup> callback)
```
    指定したグループの情報を取得する(マルチテナント非対応)。
    Groupバケットおよび対象グループのread権限が必要。
    
    パラメータ:
    
    groupName - グループ情報取得対象のグループ名
    
    callback - グループ情報を取得するコールバック
    
    導入されたバージョン:
    
    6.5.0
  - getGroup
```
@Deprecated
public static void getGroup(NbService service,
                                        java.lang.String groupName,
                                        NbGroupsCallback callback)
```
    非推奨です。 getGroup(NbService, String, NbCallback) で置き換え
    
    指定したグループの情報を取得する(マルチテナント対応)。
    
    導入されたバージョン:
    
    3.0
  - getGroup
```
public static void getGroup(NbService service,
                            java.lang.String groupName,
                            NbCallback<NbGroup> callback)
```
    指定したグループの情報を取得する(マルチテナント非対応)。
    Groupバケットおよび対象グループのread権限が必要。
    
    パラメータ:
    
    service - NbService
    
    groupName - グループ情報取得対象のグループ名
    
    callback - グループ情報を取得するコールバック
    
    導入されたバージョン:
    
    6.5.0
  - delete
```
public void delete(NbResultCallback callback)
```
    グループの削除を行う。
    Groupバケットおよび対象グループのdelete権限が必要。
    
    パラメータ:
    
    callback - APIの実行結果を取得するコールバック
    
    関連項目:
    
    NbResultCallback
  - __resetNebulaService
```
public static void __resetNebulaService()
```
  - getUsers
```
public java.util.List<java.lang.String> getUsers()
```
    グループに所属するユーザIDの一覧を取得する。
    
    戻り値:
    
    グループに所属するユーザIDのリスト
  - setUsers
```
public NbGroup setUsers(java.util.List<java.lang.String> users)
```
    グループに所属するユーザIDの一覧を設定する。
    save()を実行するまで設定値は保存されない。
    
    パラメータ:
    
    users - グループに所属するユーザIDのリスト
    
    関連項目:
    
    save(NbCallback)
  - addUser
```
public NbGroup addUser(java.lang.String userId)
```
    グループに所属するユーザを追加する。ユーザの指定にはユーザIDを用いる (ユーザ名ではない)
    
    パラメータ:
    
    userId - グループに追加するユーザID
    
    関連項目:
    
    save(NbCallback)
  - addUser
```
public NbGroup addUser(NbUser user)
```
    グループに所属するユーザを追加する。
    
    パラメータ:
    
    user - ユーザ
    
    関連項目:
    
    save(NbCallback)
  - removeUser
```
public NbGroup removeUser(java.lang.String userId)
```
    グループに所属するユーザを削除する。ユーザの指定にはユーザIDを用いる (ユーザ名ではない)
    
    パラメータ:
    
    userId - グループから削除するユーザID
  - removeUser
```
public NbGroup removeUser(NbUser user)
```
    グループに所属するユーザを削除する。
    
    パラメータ:
    
    user - グループから削除するユーザ
  - getGroups
```
public java.util.List<java.lang.String> getGroups()
```
    グループに所属するグループの一覧を取得する。
    
    戻り値:
    
    グループに所属するグループ名のリスト
  - setGroups
```
public NbGroup setGroups(java.util.List<java.lang.String> groups)
```
    グループに所属するグループの一覧を設定する。
    
    パラメータ:
    
    groups - グループに所属するグループ名のリスト
    
    関連項目:
    
    save(NbCallback)
  - addGroup
```
public NbGroup addGroup(java.lang.String group)
```
    グループに所属するグループを追加する。
    
    パラメータ:
    
    group - グループに追加するグループ名
    
    関連項目:
    
    save(NbCallback)
  - addGroup
```
public NbGroup addGroup(NbGroup group)
```
    グループに所属するグループを追加する。
    
    パラメータ:
    
    group - グループに追加するグループ
    
    関連項目:
    
    save(NbCallback)
  - removeGroup
```
public NbGroup removeGroup(java.lang.String group)
```
    グループに所属するグループを削除する。
    
    パラメータ:
    
    group - グループから削除するグループ名
    
    関連項目:
    
    save(NbCallback)
  - removeGroup
```
public NbGroup removeGroup(NbGroup group)
```
    グループに所属するグループを削除する。
    
    パラメータ:
    
    group - グループから削除するグループ
    
    関連項目:
    
    save(NbCallback)
  - getAcl
```
public NbAcl getAcl()
```
    グループのACLを取得する。
    
    戻り値:
    
    グループのACL
  - setAcl
```
public NbGroup setAcl(NbAcl acl)
```
    グループのACLを設定する。
    
    パラメータ:
    
    acl - グループに設定するACL
    
    関連項目:
    
    save(NbCallback)
  - getGroupName
```
public java.lang.String getGroupName()
```
    グループ名を取得する。
    
    戻り値:
    
    グループの名前。
  - getId
```
public java.lang.String getId()
```
    グループのIDを取得する。
    
    戻り値:
    
    グループのID
  - getETag
```
public java.lang.String getETag()
```
    グループのETagを取得する。
    
    戻り値:
    
    グループのETag
  - setETag
```
public NbGroup setETag(java.lang.String eTag)
```
  - getCreatedTime
```
public java.lang.String getCreatedTime()
```
    グループが作成された時間を取得する。
    
    戻り値:
    
    グループの作成時間
  - getUpdatedTime
```
public java.lang.String getUpdatedTime()
```
    グループが更新された時間を取得する。
    
    戻り値:
    
    グループの更新時間
  - toJsonObject
```
public NbJSONObject toJsonObject()
```
    NbGroup をグループの JSON 表現に変換する。
    
    戻り値:
    
    グループの JSON 表現
  - _getService
```
public NbService _getService()
```

クラス NbGroup

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

NbGroup

NbGroup

メソッドの詳細

save

save

query

query

getGroup

getGroup

getGroup

getGroup

delete

__resetNebulaService

getUsers

setUsers

addUser

addUser

removeUser

removeUser

getGroups

setGroups

addGroup

addGroup

removeGroup

removeGroup

getAcl

setAcl

getGroupName

getId

getETag

setETag

getCreatedTime

getUpdatedTime

toJsonObject

_getService