summaryrefslogtreecommitdiff
path: root/modules/pseudoclients/memoserv.h
blob: 0bf0c79ca664c6389641623492c0b88f22677ac0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#ifndef MEMOSERV_H
#define MEMOSERV_H

class MemoServService : public Service
{
 public:
	enum MemoResult
	{
		MEMO_SUCCESS,
		MEMO_INVALID_TARGET,
		MEMO_TOO_FAST,
		MEMO_TARGET_FULL
	};

	MemoServService(Module *m) : Service(m, "MemoServ") { }

	/** Retrieve the memo info for a nick or channel
	 * @param target Target
	 * @param ischan Set to true if target is a channel
	 * @return A memoinfo structure or NULL
	 */
 	virtual MemoInfo *GetMemoInfo(const Anope::string &target, bool &ischan) = 0;

	/** Sends a memo.
	 * @param source The source of the memo, can be anythin.
	 * @param target The target of the memo, nick or channel.
	 * @param message Memo text
	 * @param force true to force the memo, restrictions/delays etc are not checked
	 */
	virtual MemoResult Send(const Anope::string &source, const Anope::string &target, const Anope::string &message, bool force = false) = 0;

	/** Check for new memos and notify the user if there are any
	 * @param u The user
	 */
	virtual void Check(User *u) = 0;
};

static service_reference<MemoServService> memoserv("MemoServ");

#endif // MEMOSERV_H