Stream Chat Unreal SDK
Loading...
Searching...
No Matches
UChannelContextWidget Class Referencefinal

Provide a reference to a UChatChannel to child widgets. More...

#include <ChannelContextWidget.h>

Public Member Functions

void Setup (UChatChannel *InChannel)
 
UChatChannelGetChannel () const
 
void OpenThread (const FMessage &ParentMessage)
 Open the thread hanging off the given message.
 
void CloseThread ()
 Leave the open thread and go back to the channel. Does nothing if no thread is open.
 
bool IsThreadOpen () const
 
const FMessageGetThreadParentMessage () const
 The message whose thread is open. Only meaningful while IsThreadOpen().
 

Static Public Member Functions

static UChannelContextWidgetGet (const UWidget *Widget)
 
static UChannelContextWidgetTryGet (const UWidget *Widget)
 
static UChatChannelGetChannel (const UWidget *Widget)
 
static UChatChannelTryGetChannel (const UWidget *Widget)
 

Public Attributes

FStartEditMessageDelegate OnStartEditMessage
 
FThreadChangedDelegate OnThreadChanged
 Fired when a thread is opened or closed, so the message list, composer and header can follow.
 

Detailed Description

Provide a reference to a UChatChannel to child widgets.

A widget that can be initialized with a ChatChannel in order to conveniently provide children with access to said channel as well as channel-related UI delegates

Member Function Documentation

◆ OpenThread()

void UChannelContextWidget::OpenThread ( const FMessage & ParentMessage)

Open the thread hanging off the given message.

The message list switches to the thread's replies and the composer starts sending into it. Also fetches the thread's replies, since channel state does not carry them.


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