Anope IRC Services  Version 2.0
Public Types | Public Member Functions
MemoServService Class Referenceabstract

#include <memoserv.h>

Inheritance diagram for MemoServService:
Inheritance graph
[legend]
Collaboration diagram for MemoServService:
Collaboration graph
[legend]

Public Types

enum  MemoResult { MEMO_SUCCESS, MEMO_INVALID_TARGET, MEMO_TOO_FAST, MEMO_TARGET_FULL }
 

Public Member Functions

 MemoServService (Module *m)
 
virtual MemoResult Send (const Anope::string &source, const Anope::string &target, const Anope::string &message, bool force=false)=0
 
virtual void Check (User *u)=0
 
- Public Member Functions inherited from Service
 Service (Module *o, const Anope::string &t, const Anope::string &n)
 
virtual ~Service ()
 
void Register ()
 
void Unregister ()
 
- Public Member Functions inherited from Base
 Base ()
 
virtual ~Base ()
 
void AddReference (ReferenceBase *r)
 
void DelReference (ReferenceBase *r)
 

Additional Inherited Members

- Static Public Member Functions inherited from Service
static ServiceFindService (const Anope::string &t, const Anope::string &n)
 
static std::vector< Anope::stringGetServiceKeys (const Anope::string &t)
 
static void AddAlias (const Anope::string &t, const Anope::string &n, const Anope::string &v)
 
static void DelAlias (const Anope::string &t, const Anope::string &n)
 
- Data Fields inherited from Service
Moduleowner
 
Anope::string type
 
Anope::string name
 

Detailed Description

Definition at line 4 of file memoserv.h.

Member Enumeration Documentation

Enumerator
MEMO_SUCCESS 
MEMO_INVALID_TARGET 
MEMO_TOO_FAST 
MEMO_TARGET_FULL 

Definition at line 7 of file memoserv.h.

Constructor & Destructor Documentation

MemoServService::MemoServService ( Module m)
inline

Definition at line 15 of file memoserv.h.

Member Function Documentation

virtual void MemoServService::Check ( User u)
pure virtual

Check for new memos and notify the user if there are any

Parameters
uThe user

Implemented in MemoServCore.

virtual MemoResult MemoServService::Send ( const Anope::string source,
const Anope::string target,
const Anope::string message,
bool  force = false 
)
pure virtual

Sends a memo.

Parameters
sourceThe source of the memo, can be anythin.
targetThe target of the memo, nick or channel.
messageMemo text
forcetrue to force the memo, restrictions/delays etc are not checked

Implemented in MemoServCore.

Referenced by rsend_notify().


The documentation for this class was generated from the following file: