Shared/com.erfangholami.androidsolidservices.shared.model.grant/AccessLevel

AccessLevel

@Serializable

How much an app may do on the target of a grant entry.

The levels form a ladder: each one includes everything below it. The first three carry the meaning the user already knows from shares as View, Add and Edit. FULL adds what no ordinary app should hold: changing who else may reach the user's data, and speaking to other people's inboxes as the user.

Declaration order is the ladder, which includes relies on, and the names are what a host persists; append new levels at the end and never rename one.

Entries

VIEW

Read, head, list, probe and stream a resource; read a data module.

ADD

VIEW, plus creating new members in a container by POST; creating in a data module.

EDIT

ADD, plus creating by PUT, updating, patching, deleting, renaming and streaming writes; updating and deleting in a data module.

FULL

EDIT, plus every sharing verb, access-control repair, the catalog, and sending notifications as the user.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<AccessLevel>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

includes

fun includes(required: AccessLevel): Boolean

true when this level grants at least what required grants.

valueOf

fun valueOf(value: String): AccessLevel

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

values

fun values(): Array<AccessLevel>

Returns an array containing the constants of this enum type, in the order they're declared.