From 7b33dd177524aa9276aabf088f485c571949124b Mon Sep 17 00:00:00 2001 From: Jason Volk Date: Wed, 28 Aug 2019 14:57:26 -0700 Subject: [PATCH] ircd::m::receipt: Add briefs on interface. --- include/ircd/m/receipt.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/include/ircd/m/receipt.h b/include/ircd/m/receipt.h index 48f3994c3..4dca8421b 100644 --- a/include/ircd/m/receipt.h +++ b/include/ircd/m/receipt.h @@ -13,15 +13,24 @@ namespace ircd::m::receipt { - // [GET] + // [GET] Query if the user has ever read the event. bool exists(const id::room &, const id::user &, const id::event &); + + // [GET] Query if already read a later event in the room; false if so. bool freshest(const id::room &, const id::user &, const id::event &); + + // [GET] Query if the user is not *sending* receipts for certain events + // matched internal features of this interface (i.e by sender). bool ignoring(const m::user &, const id::event &); + + // [GET] Query if the user is not *sending* receipts to an entire room. bool ignoring(const m::user &, const id::room &); + + // [GET] Get the last event the user has read in the room. bool read(const id::room &, const id::user &, const id::event::closure &); id::event read(id::event::buf &out, const id::room &, const id::user &); - // [SET] + // [SET] Indicate that the user has read the event in the room. id::event::buf read(const id::room &, const id::user &, const id::event &, const time_t &); id::event::buf read(const id::room &, const id::user &, const id::event &); // now };