Message.h

// Copyright 2026 Stream.IO, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channel/Attachment.h"
#include "CoreMinimal.h"
#include "Moderation/MessageModeration.h"
#include "Reaction/Reactions.h"
#include "Response/Channel/ChannelStateResponseFieldsDto.h"
#include "Response/Message/SearchResultDto.h"
#include "User/UserRef.h"
 
#include "Message.generated.h"
 
struct FMessageDto;
struct FMessageRequestDto;
 
UENUM(BlueprintType)
enum class EMessageSendState : uint8
{
    None,
    Sending,
    Sent,
    Updating,
    Deleting,
    Failed
};
 
UENUM(BlueprintType)
enum class EMessageType : uint8
{
    Regular,
    Ephemeral,
    Error,
    Reply,
    System,
    Deleted
};
 
USTRUCT(BlueprintType)
struct STREAMCHAT_API FMessage
{
    GENERATED_BODY()
 
    
    FMessage();
    explicit FMessage(const FMessageDto&, UUserManager*);
    explicit FMessage(const FSearchResultDto&, UUserManager*);
    explicit FMessage(const FString& Text);
    FMessageRequestDto ToRequestDto(const FString& ChannelCid) const;
 
    bool IsThreadReply() const;
 
    bool IsThreadStart() const;
 
    bool IsBounced() const;
 
    bool IsRemovedByModeration() const;
 
    bool IsModerationError() const;
 
    bool IsQuoting() const;
 
    const FString& GetTranslation(const FString& Language) const;
 
    UPROPERTY()
    FString Id;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FString Cid;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    FString Text;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    EMessageSendState State = EMessageSendState::None;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FUserRef User;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    EMessageType Type = EMessageType::Regular;
 
    UPROPERTY()
    TArray<FUserRef> MentionedUsers;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FDateTime CreatedAt = FDateTime{0};
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FDateTime UpdatedAt = FDateTime{0};
 
    TOptional<FDateTime> DeletedAt;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FReactions Reactions;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    FString ParentId;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    bool bShowInChannel = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    int32 ReplyCount = 0;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    TArray<FUserRef> ThreadParticipants;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message", AdvancedDisplay)
    bool bIsSilent = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message", AdvancedDisplay)
    bool bIsShadowed = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message", AdvancedDisplay)
    FMessageModeration Moderation;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FString Html;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    TArray<FAttachment> Attachments;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FString Command;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    bool bPinned = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FDateTime PinnedAt = FDateTime{0};
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message")
    FUserRef PinnedBy;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    FDateTime PinExpires = FDateTime{0};
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "Stream Chat|Message")
    FString QuotedMessageId;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message", AdvancedDisplay)
    TMap<FString, FString> Translations;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Stream Chat|Message", AdvancedDisplay)
    FString OriginalLanguage;
 
    UPROPERTY(BlueprintReadWrite, Category = "Stream Chat|Message", AdvancedDisplay)
    FAdditionalFields ExtraData;
};