//
//  MLMessage.h
//  Monal
//
//  Created by Anurodh Pokharel on 11/27/19.
//  Copyright © 2019 Monal.im. All rights reserved.
//

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@class MLContact;

/**
 message object intended to be passed around and eventually used to render
 */
@interface MLMessage : NSObject <NSSecureCoding>

+(BOOL) supportsSecureCoding;

@property (readonly) NSString* id;     //for Identifiable protocol

/**
 account number in the database should be an integer
 */
@property (nonatomic, copy) NSNumber* accountID;

/**
  jid of the contact that this msg corresponds to
 */
@property (nonatomic, copy) NSString* buddyName;

/**
  indicating if the message was send from buddyName
 */
@property (nonatomic, assign) BOOL inbound;

/**
 The message's local  unique identifier
 */
@property (nonatomic, copy) NSString* messageId;

/**
 The id for the message as provided by the xmpp server
 */
@property (nonatomic, copy) NSString* stanzaId;

/**
The of the message in the DB , should be int
 */
@property (nonatomic, copy) NSNumber* messageDBId;

/**
 Actual sender will differ from the "from" when in a group chat
 */
@property (nonatomic, copy) NSString* actualFrom;
@property (nonatomic, assign) BOOL isMuc;
@property (nonatomic, readonly) NSString* contactDisplayName;

@property (nonatomic, copy) NSString* messageType;
@property (nonatomic, copy) NSString* mucType;
@property (nonatomic, copy) NSString* participantJid;

@property (nonatomic, copy) NSString* filetransferMimeType;
@property (nonatomic, copy) NSNumber* filetransferSize;

@property (nonatomic, copy) NSString* messageText;

@property (nonatomic, assign) BOOL retracted;

/**
 If the text was parsed into a URL. For message type url
 */
@property (nonatomic, copy) NSURL* url;

/**
 path to preview image for image type
 */
@property (nonatomic, copy) NSURL* previewImage;
@property (nonatomic, copy) NSString* previewText;

/**
 for message type status. The MUC subeject
 */
@property (nonatomic, copy) NSString* groupSubject;
@property (nonatomic, copy) NSDate* timestamp;

/*
 usually used to indicate if the message was  encrypted on the wire, not in this payload
 */
@property (nonatomic, assign) BOOL encrypted;

/*
 whether the text was acked by the server
 */
@property (nonatomic, assign) BOOL hasBeenSent;

/*
 Whether a message was recieved by the device on the other end
 */
@property (nonatomic, assign) BOOL hasBeenReceived;
@property (nonatomic, assign) BOOL hasBeenDisplayed;

/**
 values only set if in a response the message was marked as error.
 if hasBeenReceived is true, these should be ignored
 */
@property (nonatomic, copy) NSString* errorType;
@property (nonatomic, copy) NSString* errorReason;

/*
 the message has not been marked as read in the db
 */
@property (nonatomic, assign) BOOL unread;
@property (nonatomic, assign) BOOL displayMarkerWanted;

/**
 Converts a dictonary to a message object Provide a formatter for the format the dates will be in
 */
+(MLMessage*) messageFromDictionary:(NSDictionary*) dic;

-(void) updateWithMessage:(MLMessage*) msg;
@property (nonatomic, readonly) MLContact* contact;

-(BOOL) isEqualToContact:(MLContact*) contact;
-(BOOL) isEqualToMessage:(MLMessage*) message;
-(BOOL) isEqual:(id _Nullable) object;

@property (strong, readonly) NSString* description;

@end

NS_ASSUME_NONNULL_END