com.avos.avoscloud

类 AVRole

java.lang.Object

com.avos.avoscloud.AVObject

com.avos.avoscloud.AVRole

public final class AVRole
extends AVObject

Represents a Role on the AVOSCloud server. AVRoles represent groupings of AVUsers for the purposes of granting permissions (e.g. specifying a AVACL for a AVObject). Roles are specified by their sets of child users and child roles, all of which are granted any permissions that the parent role has.

Roles must have a name (which cannot be changed after creation of the role), and must specify an ACL.

嵌套类概要

从类继承的嵌套类/接口 com.avos.avoscloud.AVObject

AVObject.AVObjectCreator

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	AVROLE_ENDPOINT
static java.lang.String	className
static Creator	CREATOR

从类继承的字段 com.avos.avoscloud.AVObject

CREATED_AT, INVALID_KEYS, OBJECT_ID, UPDATED_AT

构造器概要

构造器

构造器和说明
AVRole()
AVRole(java.lang.String name) Constructs a new AVRole with the given name.
AVRole(java.lang.String name, AVACL acl) Constructs a new AVRole with the given name.

方法概要

限定符和类型	方法和说明
java.lang.String	getName() Gets the name of the role.
static AVQuery<AVRole>	getQuery() Gets a AVQuery over the Role collection.
AVRelation	getRoles() Gets the AVRelation for the AVRoles that are direct children of this role.
AVRelation	getUsers() Gets the AVRelation for the AVUsers that are direct children of this role.
void	put(java.lang.String key, java.lang.Object value) Add a key-value pair to this object.
void	setName(java.lang.String name) Sets the name for a role.

从类继承的方法 com.avos.avoscloud.AVObject

add, addAll, addAllUnique, addUnique, containsKey, create, createWithoutData, createWithoutData, delete, delete, deleteAll, deleteAllInBackground, deleteEventually, deleteEventually, deleteInBackground, deleteInBackground, deleteInBackground, deleteInBackground, describeContents, equals, fetch, fetch, fetchAll, fetchAllIfNeeded, fetchAllIfNeededInBackground, fetchAllInBackground, fetchIfNeeded, fetchIfNeeded, fetchIfNeededInBackground, fetchIfNeededInBackground, fetchInBackground, fetchInBackground, get, getACL, getAVFile, getAVGeoPoint, getAVObject, getAVObject, getAVUser, getAVUser, getBoolean, getBytes, getClassName, getCreatedAt, getDate, getDouble, getInt, getJSONArray, getJSONObject, getList, getList, getLong, getMap, getNumber, getObjectId, getQuery, getRelation, getString, getUpdatedAt, getUuid, has, hashCode, hasSameId, increment, increment, isDataAvailable, isFetchWhenSave, keySet, parseAVObject, refresh, refresh, refreshInBackground, refreshInBackground, registerSubclass, remove, removeAll, save, save, saveAll, saveAllInBackground, saveAllInBackground, saveEventually, saveEventually, saveFileBeforeSave, saveInBackground, saveInBackground, saveInBackground, saveInBackground, setACL, setFetchWhenSave, setObjectId, toJSONObject, toString, writeToParcel

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

字段详细资料

className

public static final java.lang.String className

另请参阅:

常量字段值

AVROLE_ENDPOINT

public static final java.lang.String AVROLE_ENDPOINT

另请参阅:

常量字段值

CREATOR

public static final transient Creator CREATOR

构造器详细资料

AVRole

public AVRole()

AVRole

public AVRole(java.lang.String name)

Constructs a new AVRole with the given name. If no default ACL has been specified, you must provide an ACL for the role.

参数:

name - The name of the Role to create.

AVRole

public AVRole(java.lang.String name,
              AVACL acl)

Constructs a new AVRole with the given name.

参数:

name - The name of the Role to create.

acl - The ACL for this role. Roles must have an ACL.

方法详细资料

getName

public java.lang.String getName()

Gets the name of the role.

返回:

the name of the role.

getQuery

public static AVQuery<AVRole> getQuery()

Gets a AVQuery over the Role collection.

返回:

A new query over the Role collection.

getRoles

public AVRelation getRoles()

Gets the AVRelation for the AVRoles that are direct children of this role. These roles' users are granted any privileges that this role has been granted (e.g. read or write access through ACLs). You can add or remove child roles from this role through this relation.

返回:

the relation for the roles belonging to this role.

getUsers

public AVRelation getUsers()

Gets the AVRelation for the AVUsers that are direct children of this role. These users are granted any privileges that this role has been granted (e.g. read or write access through ACLs). You can add or remove users from the role through this relation.

返回:

the relation for the users belonging to this role.

put

public void put(java.lang.String key,
                java.lang.Object value)

Add a key-value pair to this object. It is recommended to name keys in partialCamelCaseLikeThis.

覆盖:

put 在类中 AVObject

参数:

key - Keys must be alphanumerical plus underscore, and start with a letter.

value - Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or other AVObjects.

setName

public void setName(java.lang.String name)

Sets the name for a role. This value must be set before the role has been saved to the server, and cannot be set once the role has been saved.

A role's name can only contain alphanumeric characters, _, -, and spaces.

参数:

name - The name of the role.