View Source Appwrite.Utils.Permission (appwrite v0.1.9)

A helper module for generating permission strings for resources.

Summary

create(role)

Generates a create permission string for the provided role.

delete(role)

Generates a delete permission string for the provided role.

read(role)

Generates a read permission string for the provided role.

update(role)

Generates an update permission string for the provided role.

write(role)

Generates a write permission string for the provided role.

@spec create(String.t()) :: String.t()

Generates a create permission string for the provided role.

iex> Permission.create("editor")
"create("editor")"

@spec delete(String.t()) :: String.t()

Generates a delete permission string for the provided role.

iex> Permission.delete("admin")
"delete("admin")"

@spec read(String.t()) :: String.t()

Generates a read permission string for the provided role.

iex> Permission.read("user")
"read("user")"

@spec update(String.t()) :: String.t()

Generates an update permission string for the provided role.

iex> Permission.update("moderator")
"update("moderator")"

@spec write(String.t()) :: String.t()

Generates a write permission string for the provided role.

This is an alias of update, delete, and possibly create. Avoid using write in combination with update, delete, or create.

iex> Permission.write("admin")
"write("admin")"