Navigation
API > API/Plugins > API/Plugins/Party
Base SocialCore chat channel class (partial ISocialChatChannel implementation)
| Name | USocialChatChannel |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Chat/SocialChatChannel.h |
| Include Path | #include "Chat/SocialChatChannel.h" |
Syntax
UCLASS (MinimalAPI, Abstract, Within=SocialChatManager)
class USocialChatChannel : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USocialChatChannel
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USocialChatChannel() |
Chat/SocialChatChannel.h |
Classes
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsHidden | bool | Chat/SocialChatChannel.h | ||
| MessageHistory | TArray< FSocialChatMessageRef > | Chat/SocialChatChannel.h | ||
| OnChannelDisplayNameChangedEvent | FOnChannelDisplayNameChanged | Chat/SocialChatChannel.h | ||
| OnHiddenChangedEvent | FOnHiddenChanged | Chat/SocialChatChannel.h | ||
| OnMessageReceivedEvent | FOnMessageReceived | Chat/SocialChatChannel.h | ||
| OnUserChangedEvent | FOnChannelUserChanged | Chat/SocialChatChannel.h | ||
| OnUserJoinedEvent | FOnChannelUserChanged | Chat/SocialChatChannel.h | ||
| OnUserLeftEvent | FOnChannelUserChanged | Chat/SocialChatChannel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddMirroredMessage
(
FSocialChatMessageRef NewMessage |
Used by external classes to duplicate a message into a channel that didn't otherwise receive it | Chat/SocialChatChannel.h | |
void AddSystemMessage
(
const FText& MessageBody |
Chat/SocialChatChannel.h | ||
virtual const FText & GetChannelDisplayName() |
Chat/SocialChatChannel.h | ||
ESocialChannelType GetChannelType() |
Chat/SocialChatChannel.h | ||
bool GetIsHidden() |
Chat/SocialChatChannel.h | ||
virtual const TArray< FSocialChatMessageRef > & GetMessageHistory() |
Chat/SocialChatChannel.h | ||
virtual void HandleListenedChannelMessageReceived
(
const FSocialChatMessageRef& Message, |
Chat/SocialChatChannel.h | ||
virtual void Initialize
(
USocialUser* InSocialUser, |
Chat/SocialChatChannel.h | ||
virtual void InjectLocalMessage
(
const TSharedRef< FSocialLocalChatMessage >& LocalMessage |
Manually adds the given message to the channel's log locally. | Chat/SocialChatChannel.h | |
virtual void ListenToChannel
(
USocialChatChannel& Channel |
Chat/SocialChatChannel.h | ||
void NotifyChannelUserChanged
(
USocialUser& InUser |
Chat/SocialChatChannel.h | ||
void NotifyMessageReceived
(
const TSharedRef< FChatMessage >& InChatMessage |
Chat/SocialChatChannel.h | ||
void NotifyUserJoinedChannel
(
USocialUser& InUser |
Chat/SocialChatChannel.h | ||
void NotifyUserLeftChannel
(
USocialUser& InUser |
Chat/SocialChatChannel.h | ||
virtual FOnChannelDisplayNameChanged & OnChannelDisplayNameChanged() |
Chat/SocialChatChannel.h | ||
virtual FOnChannelUserChanged & OnChannelUserChanged() |
Chat/SocialChatChannel.h | ||
FOnHiddenChanged & OnHiddenChanged() |
Chat/SocialChatChannel.h | ||
virtual FOnMessageReceived & OnMessageReceived() |
Chat/SocialChatChannel.h | ||
virtual FOnChannelUserChanged & OnUserJoinedChannel() |
Chat/SocialChatChannel.h | ||
virtual FOnChannelUserChanged & OnUserLeftChannel() |
Chat/SocialChatChannel.h | ||
virtual bool SendMessage
(
const FString& Message |
Sends a text message to all other users in this channel. | Chat/SocialChatChannel.h | |
virtual void SetAutoUpdatePeriod
(
float |
Chat/SocialChatChannel.h | ||
void SetChannelDisplayName
(
const FText& InDisplayName |
Chat/SocialChatChannel.h | ||
void SetChannelType
(
ESocialChannelType InType |
Chat/SocialChatChannel.h | ||
void SetIsHidden
(
bool InValue |
Chat/SocialChatChannel.h | ||
virtual bool SupportsMessageSending() |
Chat/SocialChatChannel.h | ||
virtual void UpdateNow() |
Chat/SocialChatChannel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddMessageInternal
(
FSocialChatMessageRef NewMessage |
Chat/SocialChatChannel.h | ||
IOnlineChatPtr GetChatInterface() |
Chat/SocialChatChannel.h | ||
USocialToolkit & GetOwningToolkit() |
Chat/SocialChatChannel.h | ||
void SanitizeMessage
(
FString& RawMessage |
Chat/SocialChatChannel.h |