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

#/components/schemas/Attachment A file, image or link attached to a message. More...

#include <AttachmentDto.h>

Public Attributes

FString Type
 
FString Title
 Display title, conventionally the original filename.
 
FString TitleLink
 URL the title links to.
 
FString Text
 Description text.
 
FString AssetUrl
 URL of the uploaded file. Set for non-image attachments.
 
FString ImageUrl
 URL of the uploaded image. Set for image attachments.
 
FString ThumbUrl
 URL of a smaller preview of the image, when the backend generated one.
 
FString MimeType
 MIME type of the attached file, e.g. image/png
 
int32 FileSize = 0
 
FString OgScrapeUrl
 URL that was scraped to produce this attachment, for link previews.
 
FString AuthorName
 Author of the scraped page.
 
FString AuthorLink
 Link to the author of the scraped page.
 
FString Fallback
 Text to show when the attachment itself cannot be rendered.
 
FAdditionalFields AdditionalFields
 Fields the SDK does not model, kept so they survive a round trip.
 

Detailed Description

#/components/schemas/Attachment A file, image or link attached to a message.

Attachments are either supplied by the sender, produced by a slash command, or synthesised by the backend when it scrapes a URL found in the message text. Only a handful of fields are meaningful for any given attachment: an image uses ImageUrl, a file uses AssetUrl, and a scraped link fills in the OgScrapeUrl and author fields. Anything not modelled here survives in AdditionalFields.

Member Data Documentation

◆ FileSize

int32 FAttachmentDto::FileSize = 0

Size of the attached file in bytes. int32 is sufficient: Stream caps uploads at 100 MB

◆ Type

FString FAttachmentDto::Type

Attachment type, e.g. image, file, video, audio or giphy. Left empty on upload, the backend infers it from the uploaded content.


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