001/** 002 * 003 * Copyright 2003-2007 Jive Software. 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018package org.jivesoftware.smackx.muc; 019 020import org.jivesoftware.smack.XMPPConnection; 021import org.jivesoftware.smack.packet.Message; 022 023import org.jivesoftware.smackx.muc.packet.MUCUser; 024 025import org.jxmpp.jid.EntityJid; 026 027/** 028 * A listener that is fired anytime an invitation to join a MUC room is received. 029 * 030 * @author Gaston Dombiak 031 */ 032public interface InvitationListener { 033 034 /** 035 * Called when the an invitation to join a MUC room is received.<p> 036 * 037 * If the room is password-protected, the invitee will receive a password to use to join 038 * the room. If the room is members-only, the invitee may be added to the member list. 039 * 040 * @param conn the XMPPConnection that received the invitation. 041 * @param room the room that invitation refers to. 042 * @param inviter the inviter that sent the invitation. (e.g. crone1@shakespeare.lit). 043 * @param reason the reason why the inviter sent the invitation. 044 * @param password the password to use when joining the room. 045 * @param message the message used by the inviter to send the invitation. 046 * @param invitation the raw invitation received with the message. 047 */ 048 void invitationReceived(XMPPConnection conn, MultiUserChat room, EntityJid inviter, String reason, 049 String password, Message message, MUCUser.Invite invitation); 050 051}