AVACL (leancloud-common 0.1.13 API)

java.lang.Object
- com.avos.avoscloud.AVACL

```
public class AVACL
extends Object
```
A AVACL is used to control which users can access or modify a particular object. Each AVObject can have its own AVACL. You can grant read and write permissions separately to specific users, to groups of users that belong to roles, or you can grant permissions to "the public" so that, for example, any user could read a particular object but only a particular set of users could write to that object.

Constructor Summary

Constructors
Constructor and Description

AVACL()
Creates an ACL with no permissions granted.

AVACL(AVUser owner)
Creates an ACL where only the provided user has access.

Constructors
Constructor and Description
`AVACL()` Creates an ACL with no permissions granted.
`AVACL(AVUser owner)` Creates an ACL where only the provided user has access.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getPublicReadAccess()` Get whether the public is allowed to read this object.
`boolean`	`getPublicWriteAccess()` Get whether the public is allowed to write this object.
`boolean`	`getReadAccess(AVUser user)` Get whether the given user is explicitly allowed to read this object.
`boolean`	`getReadAccess(String userId)` Get whether the given user id is explicitly allowed to read this object.
`boolean`	`getRoleReadAccess(AVRole role)` Get whether users belonging to the given role are allowed to read this object.
`boolean`	`getRoleReadAccess(String roleName)` Get whether users belonging to the role with the given roleName are allowed to read this object.
`boolean`	`getRoleWriteAccess(AVRole role)` Get whether users belonging to the given role are allowed to write this object.
`boolean`	`getRoleWriteAccess(String roleName)` Get whether users belonging to the role with the given roleName are allowed to write this object.
`boolean`	`getWriteAccess(AVUser user)` Get whether the given user is explicitly allowed to write this object.
`boolean`	`getWriteAccess(String userId)` Get whether the given user id is explicitly allowed to write this object.
`static AVACL`	`parseACLWithPublicAccess(boolean read, boolean write)` Construct a AVACL object with public read/write permissions
`static void`	`setDefaultACL(AVACL acl, boolean withAccessForCurrentUser)` Sets a default ACL that will be applied to all AVObjects when they are created.
`void`	`setPublicReadAccess(boolean allowed)` Set whether the public is allowed to read this object.
`void`	`setPublicWriteAccess(boolean allowed)` Set whether the public is allowed to write this object.
`void`	`setReadAccess(AVUser user, boolean allowed)` Set whether the given user id is allowed to read this object.
`void`	`setReadAccess(String userId, boolean allowed)` Set whether the given user is allowed to read this object.
`void`	`setRoleReadAccess(AVRole role, boolean allowed)` Set whether users belonging to the given role are allowed to read this object.
`void`	`setRoleReadAccess(String roleName, boolean allowed)` Set whether users belonging to the role with the given roleName are allowed to read this object.
`void`	`setRoleWriteAccess(AVRole role, boolean allowed)` Set whether users belonging to the given role are allowed to write this object.
`void`	`setRoleWriteAccess(String roleName, boolean allowed)` Set whether users belonging to the role with the given roleName are allowed to write this object.
`void`	`setWriteAccess(AVUser user, boolean allowed)` Set whether the given user is allowed to write this object.
`void`	`setWriteAccess(String userId, boolean allowed)` Set whether the given user id is allowed to write this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AVACL
```
public AVACL()
```
    Creates an ACL with no permissions granted.
  - AVACL
```
public AVACL(AVUser owner)
```
    Creates an ACL where only the provided user has access.
    
    Parameters:
    
    owner - The only user that can read or write objects governed by this ACL.
- Method Detail
  - getPublicReadAccess
```
public boolean getPublicReadAccess()
```
    Get whether the public is allowed to read this object.
    
    Returns:
    
    Get whether the public is allowed to read this objec
  - getPublicWriteAccess
```
public boolean getPublicWriteAccess()
```
    Get whether the public is allowed to write this object.
    
    Returns:
    
    Get whether the public is allowed to write this object.
  - getReadAccess
```
public boolean getReadAccess(AVUser user)
```
    Get whether the given user is *explicitly* allowed to read this object. Even if this returns false, the user may still be able to access it if getPublicReadAccess returns true or a role that the user belongs to has read access.
    
    Parameters:
    
    user - specified user
    
    Returns:
    
    get whether the given user allowed to read this object
  - getReadAccess
```
public boolean getReadAccess(String userId)
```
    Get whether the given user id is *explicitly* allowed to read this object. Even if this returns false, the user may still be able to access it if getPublicReadAccess returns true or a role that the user belongs to has read access.
    
    Parameters:
    
    userId - user id
    
    Returns:
    
    Get whether the given user id is *explicitly* allowed to read this object
  - getRoleReadAccess
```
public boolean getRoleReadAccess(AVRole role)
```
    Get whether users belonging to the given role are allowed to read this object. Even if this returns false, the role may still be able to read it if a parent role has read access. The role must already be saved on the server and its data must have been fetched in order to use this method.
    
    Parameters:
    
    role - The role to check for access.
    
    Returns:
    
    true if the role has read access. false otherwise.
  - getRoleReadAccess
```
public boolean getRoleReadAccess(String roleName)
```
    Get whether users belonging to the role with the given roleName are allowed to read this object. Even if this returns false, the role may still be able to read it if a parent role has read access.
    
    Parameters:
    
    roleName - The name of the role.
    
    Returns:
    
    true if the role has read access. false otherwise.
  - getRoleWriteAccess
```
public boolean getRoleWriteAccess(AVRole role)
```
    Get whether users belonging to the given role are allowed to write this object. Even if this returns false, the role may still be able to write it if a parent role has write access. The role must already be saved on the server and its data must have been fetched in order to use this method.
    
    Parameters:
    
    role - The role to check for access.
    
    Returns:
    
    true if the role has write access. false otherwise.
  - getRoleWriteAccess
```
public boolean getRoleWriteAccess(String roleName)
```
    Get whether users belonging to the role with the given roleName are allowed to write this object. Even if this returns false, the role may still be able to write it if a parent role has write access.
    
    Parameters:
    
    roleName - - The name of the role.
    
    Returns:
    
    true if the role has write access. false otherwise.
  - getWriteAccess
```
public boolean getWriteAccess(AVUser user)
```
    Get whether the given user is *explicitly* allowed to write this object. Even if this returns false, the user may still be able to write it if getPublicWriteAccess returns true or a role that the user belongs to has write access.
    
    Parameters:
    
    user - user to check
    
    Returns:
    
    Get whether the given user is *explicitly* allowed to write this object
  - getWriteAccess
```
public boolean getWriteAccess(String userId)
```
    Get whether the given user id is *explicitly* allowed to write this object. Even if this returns false, the user may still be able to write it if getPublicWriteAccess returns true or a role that the user belongs to has write access.
    
    Parameters:
    
    userId - specified user id
    
    Returns:
    
    get whether the given user id is *explicitly* allowed to write this object
  - setDefaultACL
```
public static void setDefaultACL(AVACL acl,
                                 boolean withAccessForCurrentUser)
```
    Sets a default ACL that will be applied to all AVObjects when they are created.
    
    Parameters:
    
    acl - The ACL to use as a template for all AVObjects created after setDefaultACL has been called. This value will be copied and used as a template for the creation of new ACLs, so changes to the instance after setDefaultACL() has been called will not be reflected in new AVObjects.
    
    withAccessForCurrentUser - If true, the AVACL that is applied to newly-created AVObjects will provide read and write access to the AVUser.getCurrentUser() at the time of creation. If false, the provided ACL will be used without modification. If acl is null, this value is ignored.
  - parseACLWithPublicAccess
```
public static AVACL parseACLWithPublicAccess(boolean read,
                                             boolean write)
```
    Construct a AVACL object with public read/write permissions
    
    Parameters:
    
    read - whether the public is allowed to read this object
    
    write - whether the public is allowed to write this object
    
    Returns:
    
    AVACL
  - setPublicReadAccess
```
public void setPublicReadAccess(boolean allowed)
```
    Set whether the public is allowed to read this object.
    
    Parameters:
    
    allowed - public read permission
  - setPublicWriteAccess
```
public void setPublicWriteAccess(boolean allowed)
```
    Set whether the public is allowed to write this object.
    
    Parameters:
    
    allowed - public write permission
  - setReadAccess
```
public void setReadAccess(AVUser user,
                          boolean allowed)
```
    Set whether the given user id is allowed to read this object.
    
    Parameters:
    
    user - specified user
    
    allowed - read permission for specified user
  - setReadAccess
```
public void setReadAccess(String userId,
                          boolean allowed)
```
    Set whether the given user is allowed to read this object.
    
    Parameters:
    
    userId - specified user id
    
    allowed - read permission for specified user
  - setRoleReadAccess
```
public void setRoleReadAccess(AVRole role,
                              boolean allowed)
```
    Set whether users belonging to the given role are allowed to read this object. The role must already be saved on the server and its data must have been fetched in order to use this method.
    
    Parameters:
    
    role - The role to assign access.
    
    allowed - Whether the given role can read this object.
  - setRoleReadAccess
```
public void setRoleReadAccess(String roleName,
                              boolean allowed)
```
    Set whether users belonging to the role with the given roleName are allowed to read this object.
    
    Parameters:
    
    roleName - The name of the role.
    
    allowed - Whether the given role can read this object.
  - setRoleWriteAccess
```
public void setRoleWriteAccess(AVRole role,
                               boolean allowed)
```
    Set whether users belonging to the given role are allowed to write this object. The role must already be saved on the server and its data must have been fetched in order to use this method.
    
    Parameters:
    
    role - The role to assign access.
    
    allowed - Whether the given role can write this object.
  - setRoleWriteAccess
```
public void setRoleWriteAccess(String roleName,
                               boolean allowed)
```
    Set whether users belonging to the role with the given roleName are allowed to write this object.
    
    Parameters:
    
    roleName - The name of the role.
    
    allowed - Whether the given role can write this object.
  - setWriteAccess
```
public void setWriteAccess(AVUser user,
                           boolean allowed)
```
    Set whether the given user is allowed to write this object.
    
    Parameters:
    
    user - specified user
    
    allowed - write permission for specified user
  - setWriteAccess
```
public void setWriteAccess(String userId,
                           boolean allowed)
```
    Set whether the given user id is allowed to write this object.
    
    Parameters:
    
    userId - specified user id
    
    allowed - write permission for specified user

Class AVACL

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AVACL

AVACL

Method Detail

getPublicReadAccess

getPublicWriteAccess

getReadAccess

getReadAccess

getRoleReadAccess

getRoleReadAccess

getRoleWriteAccess

getRoleWriteAccess

getWriteAccess

getWriteAccess

setDefaultACL

parseACLWithPublicAccess

setPublicReadAccess

setPublicWriteAccess

setReadAccess

setReadAccess

setRoleReadAccess

setRoleReadAccess

setRoleWriteAccess

setRoleWriteAccess

setWriteAccess

setWriteAccess