net.java.sip.communicator.service.protocol
Interface ChatRoomInvitation

All Known Implementing Classes:

ChatRoomInvitationIrcImpl, ChatRoomInvitationJabberImpl

public interface ChatRoomInvitation

This interface represents an invitation, which is send from a chat room member to another user in order to invite this user to join the chat room.

Author:

Emil Ivov, Stephane Remy

Method Summary

byte[]	getChatRoomPassword() Returns the password to use when joining the room.
String	getInviter() Returns the ChatRoomMember that sent this invitation.
String	getReason() Returns the reason of this invitation, or null if there is no reason.
ChatRoom	getTargetChatRoom() Returns the ChatRoom, which is the target of this invitation.

Method Detail

getTargetChatRoom

ChatRoom getTargetChatRoom()

Returns the ChatRoom, which is the target of this invitation. The chat room returned by this method will be the room to which the user is invited to join to.

Returns:

the ChatRoom, which is the target of this invitation

getChatRoomPassword

byte[] getChatRoomPassword()

Returns the password to use when joining the room.

Returns:

the password to use when joining the room

getInviter

String getInviter()

Returns the ChatRoomMember that sent this invitation.

Returns:

the ChatRoomMember that sent this invitation.

getReason

String getReason()

Returns the reason of this invitation, or null if there is no reason.

Returns:

the reason of this invitation, or null if there is no reason