View Source Kevo (kevo_ex v0.1.0)

Top-level interface and supervisor for Kevo's API.

Summary

Functions

Returns a specification to start this module under a supervisor.

Gets the provided lock's event history. Follows the frontend's paging behavior.

Retrieves the given lock's state.

Retrieves all locks visible to the logged in user.

Locks the given lock.

Unlocks the given lock.

Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get_events(lock_id, page \\ 1, page_size \\ 10)

View Source

Gets the provided lock's event history. Follows the frontend's paging behavior.

@spec get_lock(String.t()) :: {:ok, any()} | {:error, Kevo.ApiError.t()}

Retrieves the given lock's state.

Retrieves all locks visible to the logged in user.

@spec lock(String.t()) :: :ok | {:error, Kevo.ApiError.t()}

Locks the given lock.

@spec start_link(opts :: keyword()) :: Supervisor.on_start()
@spec unlock(String.t()) :: :ok | {:error, Kevo.ApiError.t()}

Unlocks the given lock.