Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Party > Chat > USocialChatChannel

Light Theme

Dark Theme

USocialChatChannel

Base SocialCore chat channel class (partial ISocialChatChannel implementation)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USocialChatChannel

USocialChatRoom

USocialPartyChatRoom

USocialPrivateMessageChannel

USocialReadOnlyChatChannel

References

Module	Party
Header	/Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Chat/SocialChatChannel.h
Include	#include "Chat/SocialChatChannel.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Within=SocialChatManager)
class USocialChatChannel : public UObject

Remarks

Base SocialCore chat channel class (partial ISocialChatChannel implementation)

Variables

		Name	Description
	FText	ChannelDisplayName
	ESocialChannelT...	ChannelType

Constructors

	Name	Description
	USocialChatChannel()

Functions

	Name	Description
void	AddMessageInternal ( FSocialChatMessageRef NewMessage )
void	AddMirroredMessage ( FSocialChatMessageRef NewMessage )	Used by external classes to duplicate a message into a channel that didn't otherwise receive it
void	AddSystemMessage ( const FText& MessageBody )
const FText ...	GetChannelDisplayName()
ESocialChann...	GetChannelType()
IOnlineChatP...	GetChatInterface()
bool	GetIsHidden()
const TArray...	GetMessageHistory()
USocialToolk...	GetOwningToolkit()
void	HandleListenedChannelMessageReceived ( const FSocialChatMessageRef& Messa..., USocialChatChannel* SourceChan... )
void	Initialize ( USocialUser* InSocialUser, const FChatRoomId& InChannelId, ESocialChannelType InSourceChannelT... )
void	InjectLocalMessage ( const TSharedRef< FSocialLocalChatM... )	Manually adds the given message to the channel's log locally.
void	ListenToChannel ( USocialChatChannel& Channel )
void	NotifyChannelUserChanged ( USocialUser& InUser )
void	NotifyMessageReceived ( const TSharedRef< FChatMessage >& ... )
void	NotifyUserJoinedChannel ( USocialUser& InUser )
void	NotifyUserLeftChannel ( USocialUser& InUser )
FOnChannelDi...	OnChannelDisplayNameChanged()
FOnChannelUs...	OnChannelUserChanged()
FOnHiddenCha...	OnHiddenChanged()
FOnMessageRe...	OnMessageReceived()
FOnChannelUs...	OnUserJoinedChannel()
FOnChannelUs...	OnUserLeftChannel()
void	SanitizeMessage ( FString& RawMessage )
bool	SendMessage ( const FString& Message )	Sends a text message to all other users in this channel.
void	SetAutoUpdatePeriod ( float )
void	SetChannelDisplayName ( const FText& InDisplayName )
void	SetChannelType ( ESocialChannelType InType )
void	SetIsHidden ( bool InValue )
bool	SupportsMessageSending()
void	UpdateNow()

Classes

	Name	Description
	FOnChannelDisplayNameChanged
	FOnChannelUserChanged
	FOnHiddenChanged
	FOnMessageReceived

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss