linphone-ios/src/chat/chat-message/chat-message.h

126 lines
3.6 KiB
C++

/*
* chat-message.h
* Copyright (C) 2010-2018 Belledonne Communications SARL
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef _L_CHAT_MESSAGE_H_
#define _L_CHAT_MESSAGE_H_
#include <list>
#include "linphone/api/c-types.h"
#include "linphone/enums/chat-message-enums.h"
// TODO: Remove me later?
#include "address/identity-address.h"
#include "core/core-accessor.h"
#include "object/object.h"
// =============================================================================
LINPHONE_BEGIN_NAMESPACE
class AbstractChatRoom;
class Content;
class FileTransferContent;
class ChatMessagePrivate;
class Participant;
class ParticipantImdnState;
class LINPHONE_PUBLIC ChatMessage : public Object, public CoreAccessor {
friend class BasicToClientGroupChatRoom;
friend class BasicToClientGroupChatRoomPrivate;
friend class ChatRoom;
friend class ChatRoomPrivate;
friend class CpimChatMessageModifier;
friend class FileTransferChatMessageModifier;
friend class Imdn;
friend class ImdnMessagePrivate;
friend class MainDb;
friend class MainDbPrivate;
friend class RealTimeTextChatRoomPrivate;
friend class ServerGroupChatRoomPrivate;
public:
L_OVERRIDE_SHARED_FROM_THIS(ChatMessage);
L_DECLARE_ENUM(State, L_ENUM_VALUES_CHAT_MESSAGE_STATE);
L_DECLARE_ENUM(Direction, L_ENUM_VALUES_CHAT_MESSAGE_DIRECTION);
virtual ~ChatMessage ();
// ----- TODO: Remove me.
void cancelFileTransfer ();
int putCharacter (uint32_t character);
void setIsSecured (bool isSecured);
// ----- TODO: Remove me.
std::shared_ptr<AbstractChatRoom> getChatRoom () const;
void send ();
time_t getTime () const;
bool isSecured () const;
State getState () const;
Direction getDirection () const;
const std::string &getImdnMessageId () const;
const IdentityAddress &getFromAddress () const;
const IdentityAddress &getToAddress () const;
// TODO: Return a cpp reference.
const LinphoneErrorInfo *getErrorInfo () const;
bool isRead () const;
bool isReadOnly () const;
bool getToBeStored () const;
virtual void setToBeStored (bool value);
std::list<ParticipantImdnState> getParticipantsByImdnState (State state) const;
const std::list<Content *> &getContents () const;
void addContent (Content *content);
void removeContent (Content *content);
const Content &getInternalContent () const;
void setInternalContent (const Content &content);
// TODO: to replace salCustomheaders
std::string getCustomHeaderValue (const std::string &headerName) const;
void addCustomHeader (const std::string &headerName, const std::string &headerValue);
void removeCustomHeader (const std::string &headerName);
bool downloadFile (FileTransferContent *content);
bool isFileTransferInProgress();
protected:
explicit ChatMessage (ChatMessagePrivate &p);
private:
ChatMessage (const std::shared_ptr<AbstractChatRoom> &chatRoom, ChatMessage::Direction direction);
L_DECLARE_PRIVATE(ChatMessage);
L_DISABLE_COPY(ChatMessage);
};
LINPHONE_END_NAMESPACE
#endif // ifndef _L_CHAT_MESSAGE_H_