gloox 1.0
Public Member Functions
MUCInvitationHandler Class Reference

A handler that can be used to receive invitations to MUC rooms. More...

#include <mucinvitationhandler.h>

List of all members.

Public Member Functions

 MUCInvitationHandler (ClientBase *parent)
virtual ~MUCInvitationHandler ()
virtual void handleMUCInvitation (const JID &room, const JID &from, const std::string &reason, const std::string &body, const std::string &password, bool cont, const std::string &thread)=0

Detailed Description

A handler that can be used to receive invitations to MUC rooms.

Register a derived class with ClientBase::registerMUCInvitationHandler().

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.9

Definition at line 36 of file mucinvitationhandler.h.


Constructor & Destructor Documentation

MUCInvitationHandler ( ClientBase parent) [inline]

Constructor. Prepares the given ClientBase for receiving MUC invitations..

Parameters:
parentA ClientBase instance to prepare.

Definition at line 43 of file mucinvitationhandler.h.

virtual ~MUCInvitationHandler ( ) [inline, virtual]

Virtual Destructor.

Definition at line 52 of file mucinvitationhandler.h.


Member Function Documentation

virtual void handleMUCInvitation ( const JID room,
const JID from,
const std::string &  reason,
const std::string &  body,
const std::string &  password,
bool  cont,
const std::string &  thread 
) [pure virtual]

This function is called for incoming invitations to MUC rooms.

Parameters:
roomThe JID of the room you're being invited to.
fromThe JID of the inviter.
reasonA reason for the invitation.
bodyThe body of the message. May contain a MUC-service generated invitation message.
passwordOptionally, a password for the room.
contIndicates whether or not the multi-user chat is a continuation of a private chat.
threadAn optional thread identifier in case this is a continued chat.

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