AccessLevel (Realm 5.0.0-SNAPSHOT)

java.lang.Object
- java.lang.Enum<AccessLevel>
- - io.realm.permissions.AccessLevel

All Implemented Interfaces:

Serializable, Comparable<AccessLevel>
```
public enum AccessLevel
extends Enum<AccessLevel>
```
Access levels which can be granted to Realm Mobile Platform users for specific synchronized Realms, using a PermissionRequest.
Note that each access level guarantees all allowed actions provided by less permissive access levels. Specifically, users with write access to a Realm can always read from that Realm, and users with administrative access can always read or write from the Realm. This means that NONE < READ < WRITE < ADMIN.

See Also:

PermissionRequest, PermissionManager.applyPermissions(PermissionRequest, PermissionManager.ApplyPermissionsCallback)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADMIN` User can read, write, and administer the Realm.
`NONE` The user does not have access to this Realm.
`READ` User can only read the contents of the Realm.
`WRITE` User can read and write the contents of the Realm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`mayManage()` Returns `true` if the user is allowed to manage the Realm, `false` if not.
`boolean`	`mayRead()` Returns `true` if the user is allowed to read a Realm, `false` if not.
`boolean`	`mayWrite()` Returns `true` if the user is allowed to write to the Realm, `false` if not.
`static AccessLevel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AccessLevel[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final AccessLevel NONE
```
    The user does not have access to this Realm.
  - READ
```
public static final AccessLevel READ
```
    User can only read the contents of the Realm.
    Users who have read-only access to a Realm should open it using `readOnly()` and `waitForInitialRemoteData()` on the SyncConfiguration. Attempting to directly open the Realm is an error; in this case the Realm must manually be deleted using Realm.deleteRealm(RealmConfiguration) before being re-opened with the correct configuration.
```
 
 SyncConfiguration config = new SyncConfiguration(getUser(), getUrl())
     .readOnly()
     .waitForInitialRemoteData()
     .build();
 
 
```
  - WRITE
```
public static final AccessLevel WRITE
```
    User can read and write the contents of the Realm.
  - ADMIN
```
public static final AccessLevel ADMIN
```
    User can read, write, and administer the Realm. This includes both granting permissions as well as removing them again.
- Method Detail
  - values
```
public static AccessLevel[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AccessLevel c : AccessLevel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AccessLevel valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - mayRead
```
public boolean mayRead()
```
    Returns true if the user is allowed to read a Realm, false if not.
  - mayWrite
```
public boolean mayWrite()
```
    Returns true if the user is allowed to write to the Realm, false if not.
  - mayManage
```
public boolean mayManage()
```
    Returns true if the user is allowed to manage the Realm, false if not.
    Having this permission, means the user is able to grant permissions to other users as well as remove them again.

Enum AccessLevel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

READ

WRITE

ADMIN

Method Detail

values

valueOf

mayRead

mayWrite

mayManage