USocialChatManager

The chat manager is a fully passive construct that watches for creation of chat rooms and message activity therein

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Party

Header

/Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Chat/SocialChatManager.h

Include

#include "Chat/SocialChatManager.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=SocialToolkit, Config=Game)
class USocialChatManager : public UObject

Remarks

The chat manager is a fully passive construct that watches for creation of chat rooms and message activity therein

Functions

Name Description

Public function

bool

 

AreSlashCommandsEnabled()

Public function Virtual

USocialChatC...

 

CreateChatChannel

(
    FSocialChatChannelConfig& InConfig
)

TODO - Deubanks - Move to Protected here (public version in UFortChatManager once it exists)

Public function Virtual

USocialChatC...

 

CreateChatChannel

(
    USocialUser& InRecipient
)

TODO - Deubanks - Move to Protected here (public version in UFortChatManager once it exists)

Public function Static

USocialChatM...

 

CreateChatManager

(
    USocialToolkit& InOwnerToolkit
)

Public function Virtual

void

 

DisplayChatChannel

(
    USocialChatChannel& InChannel
)

Public function Virtual

void

 

ExitChatRoom

(
    const FChatRoomId& RoomId,
    ESocialSubsystem InSocialSubsystem
)

Protected function

USocialGroup...

 

FindOrCreateGroupChannel

(
    IOnlineGroupsPtr InGroupInterface,
    const FUniqueNetId& GroupId
)

Public function Virtual

void

 

FocusChatChannel

(
    USocialUser& InChannelUser
)

Public function Virtual

void

 

FocusChatChannel

(
    USocialChatChannel& InChannel
)

Public function Const

USocialChatR...

 

GetChatRoom

(
    const FChatRoomId& ChannelId
)

Public function

USocialChatC...

 

GetChatRoomForType

(
    ESocialChannelType Key
)

Public function Virtual Const

TSubclassOf<...

 

GetClassForChatRoom

(
    ESocialChannelType Type
)

Public function Virtual Const

TSubclassOf<...

 

GetClassForGroupChannel()

Public function Virtual Const

TSubclassOf<...

 

GetClassForPrivateMessage()

Public function Virtual Const

TSubclassOf<...

 

GetClassForReadOnlyChannel()

Public function Virtual Const

void

 

GetGroupChannels

(
    TArray< USocialGroupChannel* >...
)

Public function Virtual Const

void

 

GetJoinedChannels

(
    TArray< USocialChatChannel* > ...
)

Protected function Const

IOnlineChatP...

 

GetOnlineChatInterface

(
    ESocialSubsystem InSocialSubsystem
)

END KIAROS GROUP MANAGEMENT.

Protected function Const

IOnlineGroup...

 

GetOnlineGroupInterface

(
    ESocialSubsystem InSocialSubsystem
)

Public function Const

USocialToolk...

 

GetOwningToolkit()

Protected function Virtual

void

 

HandleChatPrivateMessageReceived

(
    const FUniqueNetId& LocalUserId,
    const TSharedRef< FChatMessage >& ...
)

Protected function Virtual

void

 

HandleChatRoomMessageReceived

(
    const FUniqueNetId& LocalUserId,
    const FChatRoomId& RoomId,
    const TSharedRef< FChatMessage >& ...
)

Protected function Virtual

void

 

InitializeChatManager()

Protected function Virtual

void

 

InitializeGroupChannels()

DECLARE_EVENT_OneParam(USocialChatManager, FOnChatChannelFocusRequested, USocialChatChannel&); FOnChatChannelFocusRequested& OnGroupsChanged() const { return OnChannelFocusRequestedEvent; }

Public function Virtual Const

bool

 

IsChatRestricted()

Protected function Const

bool

 

IsUniqueIdOfOwner

(
    const FUniqueNetId& LocalUserId
)

Public function Virtual

void

 

JoinChatRoomPrivate

(
    const FChatRoomId& RoomId,
    const FChatRoomConfig& InChatRoomC...,
    ESocialSubsystem InSocialSubsystem
)

Configuration for creating/joining a chat room

Public function Virtual

void

 

JoinChatRoomPublic

(
    const FChatRoomId& RoomId,
    const FChatRoomConfig& InChatRoomC...,
    ESocialSubsystem InSocialSubsystem
)

Void SendDirectMessage(const ISocialUserRef& InRecipient, const FString& InMessage); void SendMessage(const USocialChatChannel& Channel, const FString& InMessage); virtual bool SendMessage(const FString& InChannelName, const FString& InMessage) override; virtual bool SendMessage(const ISocialUserRef& InRecipient, const FString& InMessage) override;

Protected function

void

 

LocalUserInitialized

(
    USocialUser& LocalUser
)

Public function Virtual Const

FOnChatChann...

 

OnChannelCreated()

Protected function Virtual

void

 

OnChannelCreatedInternal

(
    USocialChatChannel& CreatedChannel
)

Public function Const

FOnChatChann...

 

OnChannelDisplayRequested()

Public function Const

FOnChatChann...

 

OnChannelFocusRequested()

Public function Virtual Const

FOnChatChann...

 

OnChannelLeft()

Protected function Virtual

void

 

OnChannelLeftInternal

(
    USocialChatChannel& ChannelLeft
)

Protected function

void

 

OnGroupUpdated

(
    const FUniqueNetId& GroupId
)

Protected function

void

 

RefreshGroupsRequestCompleted

(
    FGroupsResult Result
)

Protected function Virtual

ESocialChann...

 

TryChannelTypeLookupByRoomId

(
    const FChatRoomId& RoomID
)

Classes

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