Amarula.Protocol.Signal.SenderKeyStoreBehaviour behaviour (amarula v0.1.0)

View Source

Behaviour for a Signal Protocol Sender Key Store.

Summary

Callbacks

get_sender_key_record(module, t)
load_sender_key(t)
store_sender_key_record(module, t, t)

Callbacks

get_sender_key_record(module, t)

@callback get_sender_key_record(module(), Amarula.Protocol.Signal.Group.SenderKeyName.t()) ::
  {:ok, Amarula.Protocol.Signal.Group.SenderKeyRecord.t()}
  | {:error, String.t()}

load_sender_key(t)

@callback load_sender_key(Amarula.Protocol.Signal.Group.SenderKeyName.t()) ::
  {:ok, Amarula.Protocol.Signal.Group.SenderKeyRecord.t()}
  | {:error, :not_found}
  | {:error, String.t()}

store_sender_key_record(module, t, t)

@callback store_sender_key_record(
  module(),
  Amarula.Protocol.Signal.Group.SenderKeyName.t(),
  Amarula.Protocol.Signal.Group.SenderKeyRecord.t()
) :: :ok | {:error, String.t()}