com.avos.avoscloud

Class AVRole

java.lang.Object

com.avos.avoscloud.AVObject

com.avos.avoscloud.AVRole

All Implemented Interfaces:

android.os.Parcelable

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.avos.avoscloud.AVObject

AVObject.AVObjectCreator, AVObject.Hook

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	className

Fields inherited from class com.avos.avoscloud.AVObject

acl, CREATED_AT, createdAt, CREATOR, INVALID_KEYS, OBJECT_ID, objectId, requestStatistic, UPDATED_AT, updatedAt

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AVRole()
AVRole(String name) Constructs a new AVRole with the given name.
AVRole(String name, AVACL acl) Constructs a new AVRole with the given name.

Method Summary

Modifier and Type	Method and Description
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(String key, Object value) Add a key-value pair to this object.
void	setName(String name) Sets the name for a role.

Methods inherited from class com.avos.avoscloud.AVObject

add, addAll, addAllUnique, addUnique, alwaysSaveAllKeyValues, alwaysUsePost, buildBatchParameterForNonSavedObject, cast, containsKey, copyFromJson, copyFromMap, create, createWithoutData, createWithoutData, delete, delete, deleteAll, deleteAllInBackground, deleteEventually, deleteEventually, deleteInBackground, deleteInBackground, deleteInBackground, deleteInBackground, describeContents, disableAfterHook, disableBeforeHook, 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, headerMap, ignoreHook, increment, increment, internalClassName, internalId, isDataAvailable, isFetchWhenSave, keySet, onDataSynchronized, onSaveFailure, onSaveSuccess, parseAVObject, put, rebuildInstanceData, refresh, refresh, refreshInBackground, refreshInBackground, registerSubclass, remove, removeAll, save, save, saveAll, saveAllInBackground, saveAllInBackground, saveEventually, saveEventually, saveFileBeforeSave, saveInBackground, saveInBackground, saveInBackground, saveInBackground, setACL, setFetchWhenSave, setObjectId, shouldThrowException, toJSONObject, toString, writeToParcel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

className

public static final String className

See Also:

Constant Field Values

Constructor Detail

AVRole

public AVRole()

AVRole

public AVRole(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.

Parameters:

name - The name of the Role to create.

AVRole

public AVRole(String name,
              AVACL acl)

Constructs a new AVRole with the given name.

Parameters:

name - The name of the Role to create.

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

Method Detail

getName

public String getName()

Gets the name of the role.

Returns:

the name of the role.

getQuery

public static AVQuery<AVRole> getQuery()

Gets a AVQuery over the Role collection.

Returns:

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.

Returns:

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.

Returns:

the relation for the users belonging to this role.

put

public void put(String key,
                Object value)

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

Overrides:

put in class AVObject

Parameters:

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(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.

Parameters:

name - The name of the role.