Stream Chat Unreal SDK
Loading...
Searching...
No Matches
FMessageDto Struct Reference

#/components/schemas/Message Represents any chat message. Used in responses only More...

#include <MessageDto.h>

Inheritance diagram for FMessageDto:
FSearchResultMessageDto

Public Member Functions

TOptional< FDateTime > GetDeletedAt () const
 Date/time of deletion.
 

Public Attributes

TArray< FAttachmentDtoAttachments
 
FString Cid
 Channel unique identifier.
 
FString Command
 Contains provided slash command.
 
FDateTime CreatedAt = FDateTime{0}
 Date/time of creation.
 
FString Html
 Contains HTML markup of the message.
 
TMap< FString, FString > I18n
 
FString Id
 
TArray< FReactionDtoLatestReactions
 The latest reactions to the message created by any user.
 
TArray< FUserObjectDtoMentionedUsers
 The list of user mentioned in the message.
 
FString Mml
 
FMessageModerationDto Moderation
 The moderation verdict for this message, as sent by Moderation V2.
 
FMessageModerationDto ModerationDetails
 
TArray< FReactionDtoOwnReactions
 The reactions added to the message by the current user.
 
FString ParentId
 The ID of the parent message, if the message is a thread reply.
 
FDateTime PinExpires = FDateTime{0}
 When the pin lapses. Stays zeroed when the API sends null, which means the pin doesn't expire.
 
bool bPinned = false
 If true the message is pinned.
 
FDateTime PinnedAt = FDateTime{0}
 When the message was pinned. Zeroed unless it is pinned.
 
FUserObjectDto PinnedBy
 Who pinned the message. Left with an empty ID unless it is pinned.
 
FString QuotedMessageId
 The ID of the quoted message, if the message is a quoted reply.
 
TMap< FName, int32 > ReactionCounts
 A map describing the count of number of every reaction.
 
TMap< FName, int32 > ReactionScores
 A map describing the count of score of every reaction.
 
uint32 ReplyCount = 0
 Reserved field indicating the number of replies for this message.
 
bool bShadowed = false
 If true the message is shadowed.
 
bool bShowInChannel = false
 Whether thread reply should be shown in the channel as well.
 
bool bSilent = false
 If true the message is silent.
 
FString Text
 The text of this message.
 
TArray< FUserObjectDtoThreadParticipants
 Reserved field indicating the thread participants for this message.
 
EMessageTypeDto Type = EMessageTypeDto::Regular
 The message type.
 
FDateTime UpdatedAt = FDateTime{0}
 Reserved field indicating when the message was updated last time.
 
FUserObjectDto User
 
FAdditionalFields AdditionalFields
 

Detailed Description

#/components/schemas/Message Represents any chat message. Used in responses only

Member Data Documentation

◆ Attachments

TArray<FAttachmentDto> FMessageDto::Attachments

The list of attachments, either provided by the user or generated from a command or as a result of URL scraping.

◆ I18n

TMap<FString, FString> FMessageDto::I18n

Automatic translations of the message, sent only by an app with auto-translation enabled.

Keyed by <language>_text for each translation, plus a language key naming the language the message was written in. Read through FMessage rather than picking those apart here.

◆ Id

FString FMessageDto::Id

The message ID. This is either created by Stream or set client side when the message is added.

◆ Mml

FString FMessageDto::Mml

Messaging Markup Language Should be empty if text is provided

◆ ModerationDetails

FMessageModerationDto FMessageDto::ModerationDetails

The moderation verdict for this message, as sent by the older moderation API

Apps still on that version get their verdict here instead of in Moderation, so both are read.

◆ User

FUserObjectDto FMessageDto::User

User who sent the message. Left with an empty ID by the handful of payloads which omit it, which yields an invalid FUserRef on the message rather than a reference to a user who doesn't exist.


The documentation for this struct was generated from the following files: