sjero.net Git - linphone/blob - java/common/org/linphone/core/LinphoneChatRoom.java

   1 /*
   2 LinphoneChatRoom.java
   3 Copyright (C) 2010  Belledonne Communications, Grenoble, France
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18 */
  19 package org.linphone.core;
  20 /**
  21  *
  22  * A chat room is the place where text messages are exchanged.
  23 Can be created by linphone_core_create_chat_room().
  24  *
  25  */
  26 public interface LinphoneChatRoom {
  27         /**
  28          * get peer address associated to this LinphoneChatRoom
  29          *
  30          * @return LinphoneAddress peer address
  31          */
  32         LinphoneAddress getPeerAddress();
  33         /**
  34         * send a message to peer member of this chat room.
  35         * @param        message to be sent
  36         */
  37         void sendMessage(String message);
  38         /**
  39          * Send a message to peer member of this chat room.
  40          * @param chat message
  41          */
  42         void sendMessage(LinphoneChatMessage message, LinphoneChatMessage.StateListener listener);
  43         /**
  44          * DEPRECATED
  45          * @param opaque
  46          * @param message
  47          */
  48         void sendMessage(Object opaque, String message);
  49
  50         /**
  51          * Create a LinphoneChatMessage
  52          * @param chatRoom chat room associated to the message
  53          * @param message message to send
  54          * @return LinphoneChatMessage object
  55          */
  56         LinphoneChatMessage createLinphoneChatMessage(String message);
  57 }