src/net/java/sip/communicator/service/protocol/AdHocChatRoomInvitation.java


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
42
43

/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.service.protocol;

/**
 * This interface represents an invitation, which is send from an ad-hoc chat 
 * room participant to another user in order to invite this user to join the 
 * ad-hoc chat room.
 *
 * @author Valentin Martinet
 */
public interface AdHocChatRoomInvitation
{
    /**
     * Returns the <tt>AdHocChatRoom</tt>, which is the  target of this 
     * invitation.
     * The ad-hoc chat room returned by this method will be the room to which 
     * the user
     * is invited to join to.
     *
     * @return the <tt>AdHocChatRoom</tt>, which is the  target of this 
     * invitation
     */
    public AdHocChatRoom getTargetAdHocChatRoom();

    /**
     * Returns the <tt>Contact</tt> that sent this invitation.
     * 
     * @return the <tt>Contact</tt> that sent this invitation.
     */
    public String getInviter();

    /**
     * Returns the reason of this invitation, or null if there is no reason.
     *
     * @return the reason of this invitation, or null if there is no reason
     */
    public String getReason();
}