ParseACL

Parse~ ParseACL

Creates a new ACL. If no argument is given, the ACL has no permissions for anyone. If the argument is a Parse.User, the ACL will have read and write permission for only that user. If the argument is any other JSON object, that object will be interpretted as a serialized ACL created with toJSON().

An ACL, or Access Control List can be added to any Parse.Object to restrict access to only a subset of users of your application.

Constructor

new ParseACL(arg1)

Parameters:
Name Type Description
arg1 Parse.User | object

The user to initialize the ACL for

Methods

equals(other) → {boolean}

Returns whether this ACL is equal to another object

Parameters:
Name Type Description
other ParseACL

The other object's ACL to compare to
Returns:
Type:
boolean

getPublicReadAccess() → {boolean}

Gets whether the public is allowed to read this object.

Returns:
Type:
boolean

getPublicWriteAccess() → {boolean}

Gets whether the public is allowed to write this object.

Returns:
Type:
boolean

getReadAccess(userId) → {boolean}

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 write access.

Parameters:
Name Type Description
userId

An instance of Parse.User or its objectId, or a Parse.Role.
Returns:
Type:
boolean

getRoleReadAccess(role) → {boolean}

Gets 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 write it if a parent role has read access.

Parameters:
Name Type Description
role

The name of the role, or a Parse.Role object.
Throws:

If role is neither a Parse.Role nor a String.

Type
TypeError
Returns:
Type:
boolean

true if the role has read access. false otherwise.

getRoleWriteAccess(role) → {boolean}

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

Parameters:
Name Type Description
role

The name of the role, or a Parse.Role object.
Throws:

If role is neither a Parse.Role nor a String.

Type
TypeError
Returns:
Type:
boolean

true if the role has write access. false otherwise.

getWriteAccess(userId) → {boolean}

Gets 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:
Name Type Description
userId

An instance of Parse.User or its objectId, or a Parse.Role.
Returns:
Type:
boolean

setPublicReadAccess(allowed)

Sets whether the public is allowed to read this object.

Parameters:
Name Type Description
allowed boolean

setPublicWriteAccess(allowed)

Sets whether the public is allowed to write this object.

Parameters:
Name Type Description
allowed boolean

setReadAccess(userId, allowed)

Sets whether the given user is allowed to read this object.

Parameters:
Name Type Description
userId

An instance of Parse.User or its objectId.
allowed boolean

Whether that user should have read access.

setRoleReadAccess(role, allowed)

Sets whether users belonging to the given role are allowed to read this object.

Parameters:
Name Type Description
role

The name of the role, or a Parse.Role object.
allowed boolean

Whether the given role can read this object.
Throws:

If role is neither a Parse.Role nor a String.

Type
TypeError

setRoleWriteAccess(role, allowed)

Sets whether users belonging to the given role are allowed to write this object.

Parameters:
Name Type Description
role

The name of the role, or a Parse.Role object.
allowed boolean

Whether the given role can write this object.
Throws:

If role is neither a Parse.Role nor a String.

Type
TypeError

setWriteAccess(userId, allowed)

Sets whether the given user id is allowed to write this object.

Parameters:
Name Type Description
userId

An instance of Parse.User or its objectId, or a Parse.Role..
allowed boolean

Whether that user should have write access.

toJSON() → {object}

Returns a JSON-encoded version of the ACL.

Returns:
Type:
object