LeanCloud.Storage.LCRole Class Reference

LeanCloud Role, a group of users for the purposes of granting permissions. More...

Inheritance diagram for LeanCloud.Storage.LCRole:

Public Member Functions
	LCRole ()
	Constructs a LCRole.
Public Member Functions inherited from LeanCloud.Storage.LCObject
void	DisableBeforeHook ()
	Disable hooks before saving / updating / deleting LCObject.
void	DisableAfterHook ()
	Disable hooks after saving / updating / deleting LCObject.
void	IgnoreHook (string hookName)
	Ignores the hook for this LCObject.
ReadOnlyCollection< string >	GetUpdatedKeys ()
	Gets the updated keys of this LCObject.
	LCObject (string className)
	Constructs a new LCObject with no data in it. A LCObject constructed in this way will not have an ObjectedId and will not persist in the cloud until Save(bool, LCQuery<LCObject>)) is called.
void	Unset (string key)
	Removes the key.
void	AddRelation (string key, LCObject value)
	Creates a LCRelation<T> value for a key.
void	RemoveRelation (string key, LCObject value)
	Removes a LCRelation<T> value for a key.
void	Increment (string key, object value)
	Atomically increments the value of the given key with amount.
void	Add (string key, object value)
	Atomically adds value to the end of the array key.
void	AddAll (string key, IEnumerable values)
	Atomically adds values to the end of the array key.
void	AddUnique (string key, object value)
	Atomically adds value to the array key, only if not already present.
void	AddAllUnique (string key, IEnumerable values)
	Atomically adds values to the array key, only if not already present.
void	Remove (string key, object value)
	Atomically removes all value from the array key.
void	RemoveAll (string key, IEnumerable values)
	Atomically removes all values from the array key.
async Task< LCObject >	Save (bool fetchWhenSave=false, LCQuery< LCObject > query=null)
	Saves this object to the cloud.
async Task	Delete ()
	Deletes this object in the cloud.
async Task< LCObject >	Fetch (IEnumerable< string > keys=null, IEnumerable< string > includes=null)
	Fetches this object from the cloud.
override string	ToString ()
	Serializes this LCObject to a JSON string.
void	Merge (LCObjectData objectData)

Static Public Member Functions
static LCRole	Create (string name, LCACL acl)
	Constructs a LCRole with a name and a LCACL.
static LCQuery< LCRole >	GetQuery ()
	Constructs a LCQuery for this role.
Static Public Member Functions inherited from LeanCloud.Storage.LCObject
static LCObject	CreateWithoutData (string className, string objectId)
	Creates a reference to an existing LCObject.
static LCObject	Create (string className)
	Creates a new LCObject.
static async Task< List< LCObject > >	SaveAll (IEnumerable< LCObject > objects)
	Saves each object in the provided list.
static async Task	DeleteAll (IEnumerable< LCObject > objects)
	Deletes each object in the provided list.
static async Task< IEnumerable< LCObject > >	FetchAll (IEnumerable< LCObject > objects)
	Fetches all of the objects in the provided list.
static void	RegisterSubclass< T > (string className, Func< T > constructor, string endpoint=null)
	Registers a custom subclass type with LeanCloud SDK, enabling strong-typing of those LCObjects whenever they appear.
static LCObject	ParseObject (string json)
	Deserializes a JSON string to a LCObject.
static string	GetClassEndpoint (string className)

Static Public Attributes
const string	CLASS_NAME = "_Role"
const string	ENDPOINT = "roles"

Properties
string	Name [get, set]
	The name of a LCRole.
LCRelation< LCRole >	Roles [get]
	Child roles.
LCRelation< LCUser >	Users [get]
	Child users.
Properties inherited from LeanCloud.Storage.LCObject
string	ClassName [get]
	Gets the class name for the LCObject.
string	ObjectId [get]
	Gets the object id. An object id is assigned as soon as an object is saved to the server. The combination of a ClassName and an ObjectId uniquely identifies an object in your application.
DateTime	CreatedAt [get]
	Gets the creation time of this object in the cloud.
DateTime	UpdatedAt [get]
	Gets the latest update time of this object in the cloud.
LCACL	ACL [get, set]
	Gets or sets the LCACL governing this object.
bool	IsDirty [get, set]
object	this[string key] [get, set]
	Gets or sets a value on the object. It is forbidden to name keys with a leading underscore ('_').

Detailed Description

LeanCloud Role, a group of users for the purposes of granting permissions.

Constructor & Destructor Documentation

LCRole()

LeanCloud.Storage.LCRole.LCRole ( )

inline

Constructs a LCRole.

Member Function Documentation

Create()

static LCRole LeanCloud.Storage.LCRole.Create ( string  name, LCACL  acl  )

inlinestatic

Constructs a LCRole with a name and a LCACL.

Parameters

name
acl

Returns

GetQuery()

static LCQuery< LCRole > LeanCloud.Storage.LCRole.GetQuery ( )

inlinestatic

Constructs a LCQuery for this role.

Returns

Member Data Documentation

CLASS_NAME

const string LeanCloud.Storage.LCRole.CLASS_NAME = "_Role"

static

ENDPOINT

const string LeanCloud.Storage.LCRole.ENDPOINT = "roles"

static

Property Documentation

Name

string LeanCloud.Storage.LCRole.Name

getset

The name of a LCRole.

Roles

LCRelation<LCRole> LeanCloud.Storage.LCRole.Roles

get

Child roles.

Users

LCRelation<LCUser> LeanCloud.Storage.LCRole.Users

get

Child users.

---

The documentation for this class was generated from the following file:

• Storage/Storage/Public/LCRole.cs