zotonic_model behaviour (zotonic_core v1.0.0-rc.17)

Model behaviour

Summary

Types

delete_return/0
opt_msg/0
post_return/0
return/0

Callbacks

m_delete/3
m_get/3
m_post/3

Types

delete_return/0

-type delete_return() :: ok | {ok, term()} | {error, unknown_path | term()}.

opt_msg/0

-type opt_msg() :: mqtt_packet_map:mqtt_packet() | undefined.

post_return/0

-type post_return() :: ok | {ok, term()} | {error, unknown_path | term()}.

return/0

-type return() :: {ok, {term(), list()}} | {error, unknown_path | term()}.

Callbacks

m_delete/3

(optional) 
-callback m_delete([binary()], opt_msg(), z:context()) -> {ok, term()} | ok | {error, term()}.

m_get/3

-callback m_get(list(), opt_msg(), z:context()) -> return().

m_post/3

(optional) 
-callback m_post([binary()], opt_msg(), z:context()) -> {ok, term()} | ok | {error, term()}.