ncmb_kotlin/com.nifcloud.mbaas.core/NCMBAcl

NCMBAcl

class NCMBAcl

Access Control (ACL) feature class.

This class is do features on settings Access Control of data for NCMB Kotlin SDK.

Constructors

NCMBAcl

fun NCMBAcl()

Constructor with class name

NCMBAcl

fun NCMBAcl(json: JSONObject)

Constructor for NCMBAcl from JSON

Types

Companion

object Companion

Permission

class Permission

Inner class of representation for permission

Functions

addRoleKey

fun addRoleKey(key: String): String

getRoleAccess

fun getRoleAccess(roleName: String): NCMBAcl.Permission

get role access permissions

getRoleReadAccess

fun getRoleReadAccess(roleName: String): Boolean

Get whether the gevin role name is allowed to read

getRoleWriteAccess

fun getRoleWriteAccess(roleName: String): Boolean

Get whether the gevin role name is allowed to write

getUserAccess

fun getUserAccess(userId: String): NCMBAcl.Permission

get user access permissions

getUserReadAccess

fun getUserReadAccess(userId: String): Boolean

Get whether the given user id is allowed to read

getUserWriteAccess

fun getUserWriteAccess(userId: String): Boolean

Get whether the given user id is allowed to write

removeRolePermission

fun removeRolePermission(roleName: String): Boolean

Remove permisson for role (after set at local OR fetch from server)

removeUserPermission

fun removeUserPermission(userId: String): Boolean

Remove permission for user (after set at local OR fetch from server)

setRoleAccess

fun setRoleAccess(roleName: String, permission: NCMBAcl.Permission)

set role access permissions

setRoleReadAccess

fun setRoleReadAccess(roleName: String, allowed: Boolean)

Set whether the given role is allowed to read.

setRoleWriteAccess

fun setRoleWriteAccess(roleName: String, allowed: Boolean)

Set whether the given role is allowed to write.

setUserAccess

fun setUserAccess(userId: String, permission: NCMBAcl.Permission)

set user access permissions

setUserReadAccess

fun setUserReadAccess(userId: String, allowed: Boolean)

Set whether the given user id is allowed to read.

setUserWriteAccess

fun setUserWriteAccess(userId: String, allowed: Boolean)

Set whether the given user is allowed to write.

Properties

isEmpty

val isEmpty: Boolean

Check ACL is empty or not

publicReadAccess

var publicReadAccess: Boolean

Set whether the public is allowed to read.

publicWriteAccess

var publicWriteAccess: Boolean

Set whether the public is allowed to write.