View Source Rolex.Control (Rolex v0.2.0)

Provides functions for granting, denying, and revoking permissions.

Summary

Functions

deny(opts \\ [])

Creates a role-denying permission with the given options.

deny!(opts \\ [])

Creates a role-denying permission.

deny_on(noun, opts \\ [])

Creates a role-denying permission, prefilling [on: noun].

deny_on!(noun, opts \\ [])

Creates a role-denying permission, prefilling [on: noun].

deny_role(noun, opts \\ [])

Creates a role-denying permission, prefilling [role: noun].

deny_role!(noun, opts \\ [])

Creates a role-denying permission, prefilling [role: noun].

deny_to(noun, opts \\ [])

Creates a role-denying permission, prefilling [to: noun].

deny_to!(noun, opts \\ [])

Creates a role-denying permission, prefilling [to: noun].

grant(opts \\ [])

Creates a role-granting permission with the given options.

grant!(opts \\ [])

Creates a role-granting permission.

grant_on(noun, opts \\ [])

Creates a role-granting permission, prefilling [on: noun].

grant_on!(noun, opts \\ [])

Creates a role-granting permission, prefilling [on: noun].

grant_role(noun, opts \\ [])

Creates a role-granting permission, prefilling [role: noun].

grant_role!(noun, opts \\ [])

Creates a role-granting permission, prefilling [role: noun].

grant_to(noun, opts \\ [])

Creates a role-granting permission, prefilling [to: noun].

grant_to!(noun, opts \\ [])

Creates a role-granting permission, prefilling [to: noun].

multi_deny(multi \\ Ecto.Multi.new(), opts \\ [])

Adds a multi operation to create a role-denying permission.

multi_deny_on(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-denying permission, prefilling [on: noun].

multi_deny_role(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-denying permission, prefilling [role: noun].

multi_deny_to(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-denying permission, prefilling [to: noun].

multi_grant(multi \\ Ecto.Multi.new(), opts \\ [])

Adds a multi operation to create a role-granting permission.

multi_grant_on(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-granting permission, prefilling [on: noun].

multi_grant_role(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-granting permission, prefilling [role: noun].

multi_grant_to(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-granting permission, prefilling [to: noun].

multi_revoke(multi, opts)

Adds an operation to delete all permissions matching the given options exactly.

multi_revoke_from(multi, noun, opts \\ [])

Adds a multi operation to delete all permissions matching the given options exactly, prefilling [from: noun].

multi_revoke_on(multi, noun, opts \\ [])

Adds a multi operation to delete all permissions matching the given options exactly, prefilling [on: noun].

multi_revoke_role(multi, noun, opts \\ [])

Adds a multi operation to delete all permissions matching the given options exactly, prefilling [role: noun].

revoke(opts \\ [])

Deletes all permissions matching the given options.

revoke!(opts)

Deletes all permissions matching the given options exactly.

revoke_from(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [from: noun].

revoke_from!(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [from: noun].

revoke_on(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [on: noun].

revoke_on!(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [on: noun].

revoke_role(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [role: noun].

revoke_role!(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [role: noun].

Functions

deny(opts \\ [])

Creates a role-denying permission with the given options.

Returns {:ok, %Permission{}} on success.

See c:Rolex.Options for options.

deny!(opts \\ [])

Creates a role-denying permission.

Returns %Permission{} on success; raises an exception otherwise.

See c:Rolex.Options for options.

deny_on(noun, opts \\ [])

Creates a role-denying permission, prefilling [on: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

deny_on!(noun, opts \\ [])

Creates a role-denying permission, prefilling [on: noun].

Returns noun on success; raises an exception otherwise.

See c:Rolex.Options for other options.

deny_role(noun, opts \\ [])

Creates a role-denying permission, prefilling [role: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

deny_role!(noun, opts \\ [])

Creates a role-denying permission, prefilling [role: noun].

Returns noun on success; raises an exception otherwise.

See c:Rolex.Options for other options.

deny_to(noun, opts \\ [])

Creates a role-denying permission, prefilling [to: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

deny_to!(noun, opts \\ [])

Creates a role-denying permission, prefilling [to: noun].

Returns noun on success; raises an exception otherwise.

See c:Rolex.Options for other options.

grant(opts \\ [])

Creates a role-granting permission with the given options.

Returns {:ok, %Permission{}} on success.

See c:Rolex.Options for options.

grant!(opts \\ [])

Creates a role-granting permission.

Returns %Permission{} on success; raises an exception otherwise.

See c:Rolex.Options for options.

grant_on(noun, opts \\ [])

Creates a role-granting permission, prefilling [on: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

grant_on!(noun, opts \\ [])

Creates a role-granting permission, prefilling [on: noun].

Returns noun on success; raises an exception otherwise.

See c:Rolex.Options for other options.

grant_role(noun, opts \\ [])

Creates a role-granting permission, prefilling [role: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

grant_role!(noun, opts \\ [])

Creates a role-granting permission, prefilling [role: noun].

Returns noun on success; raises an exception otherwise.

See c:Rolex.Options for other options.

grant_to(noun, opts \\ [])

Creates a role-granting permission, prefilling [to: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

grant_to!(noun, opts \\ [])

Creates a role-granting permission, prefilling [to: noun].

Returns noun on success; raises an exception otherwise.

See c:Rolex.Options for other options.

multi_deny(multi \\ Ecto.Multi.new(), opts \\ [])

Adds a multi operation to create a role-denying permission.

Returns the updated multi.

See c:Rolex.Options for options.

multi_deny_on(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-denying permission, prefilling [on: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_deny_role(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-denying permission, prefilling [role: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_deny_to(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-denying permission, prefilling [to: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_grant(multi \\ Ecto.Multi.new(), opts \\ [])

Adds a multi operation to create a role-granting permission.

Returns the updated multi.

See c:Rolex.Options for options.

multi_grant_on(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-granting permission, prefilling [on: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_grant_role(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-granting permission, prefilling [role: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_grant_to(multi \\ Ecto.Multi.new(), noun, opts \\ [])

Adds a multi operation to create a role-granting permission, prefilling [to: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_revoke(multi, opts)

Adds an operation to delete all permissions matching the given options exactly.

Returns the updated multi.

See c:Rolex.Options for options.

multi_revoke_from(multi, noun, opts \\ [])

Adds a multi operation to delete all permissions matching the given options exactly, prefilling [from: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_revoke_on(multi, noun, opts \\ [])

Adds a multi operation to delete all permissions matching the given options exactly, prefilling [on: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

multi_revoke_role(multi, noun, opts \\ [])

Adds a multi operation to delete all permissions matching the given options exactly, prefilling [role: noun].

Returns the updated multi.

See c:Rolex.Options for other options.

revoke(opts \\ [])

Deletes all permissions matching the given options.

Returns {:ok, <number-of-permissions-deleted>} on success, or {:error, changeset} otherwise.

See c:Rolex.Options for options.

revoke!(opts)

Deletes all permissions matching the given options exactly.

Returns the number of permissions deleted on success; raises an exception otherwise.

See c:Rolex.Options for options.

revoke_from(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [from: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

revoke_from!(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [from: noun].

Returns the number of permissions deleted on success; raises an exception otherwise.

See c:Rolex.Options for other options.

revoke_on(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [on: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

revoke_on!(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [on: noun].

Returns the number of permissions deleted on success; raises an exception otherwise.

See c:Rolex.Options for other options.

revoke_role(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [role: noun].

Returns {:ok, noun} on success.

See c:Rolex.Options for other options.

revoke_role!(noun, opts \\ [])

Deletes all permissions matching the given options exactly, prefilling [role: noun].

Returns the number of permissions deleted on success; raises an exception otherwise.

See c:Rolex.Options for other options.