1. Epic GamesDeveloper
  3. USocialChatManager

USocialChatManager

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

API > API/Plugins > API/Plugins/Party > API/Plugins/Party/Chat

Inheritance Hierarchy

References

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

Syntax

UCLASS (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

Variables

  Type Name Description
Protected variable UProperty Config bool bEnableChatSlashCommands  
Protected variable TMap< ESocialChannelType, TWeakObjectPtr< USocialChatChannel > > ChannelsByType  
Protected variable UProperty TMap< FString, TObjectPtr< USocialChatRoom > > ChatRoomsById  
Protected variable UProperty TMap< TWeakObjectPtr< USocialUser >, TObjectPtr< USocialPrivateMessageChannel > > DirectChannelsByTargetUser  
Protected variable UProperty TMap< FUniqueNetIdRepl, TObjectPtr< USocialGroupChannel > > GroupChannels  
Protected variable FOnChatChannelCreated OnChannelCreatedEvent  
Protected variable FOnChatChannelDisplayRequested OnChannelDisplayRequestedEvent  
Protected variable FOnChatChannelFocusRequested OnChannelFocusRequestedEvent  
Protected variable FOnChatChannelLeft OnChannelLeftEvent  
Protected variable UProperty TMap< FString, TObjectPtr< USocialReadOnlyChatChannel > > ReadOnlyChannelsByDisplayName  

Functions

  Type Name Description
Public function bool  
Public function Virtual USocialChatChannel *  
Public function Virtual USocialChatChannel &

CreateChatChannel ( USocialUser& InRecipient
)

 TODO - Deubanks - Move to Protected here (public version in UFortChatManager once it exists)
Public function Static USocialChatManager *

CreateChatManager ( USocialToolkit& InOwnerToolkit
)

  
Public function Virtual void  
Public function Virtual void

ExitChatRoom ( const FChatRoomId& RoomId,
ESocialSubsystem InSocialSubsystem
)

  
Protected function USocialChatChannel &

FindOrCreateChannel ( const FText& DisplayName
)

  
Protected function USocialChatChannel &  
Protected function USocialGroupChannel &

FindOrCreateGroupChannel ( IOnlineGroupsPtr InGroupInterface,
const FUniqueNetId& GroupId
)

  
Protected function USocialChatRoom &

FindOrCreateRoom ( const FChatRoomId& RoomId
)

  
Public function Virtual void

FocusChatChannel ( USocialUser& InChannelUser
)

  
Public function Virtual void  
Public function Const USocialChatRoom *

GetChatRoom ( const FChatRoomId& ChannelId
)

  
Public function USocialChatChannel *  
Public function Virtual Const TSubclassOf< USocialChatRoom >  
Public function Virtual Const TSubclassOf< USocialGroupChannel >  
Public function Virtual Const TSubclassOf< USocialChatChannel >  
Public function Virtual Const TSubclassOf< USocialChatChannel >  
Public function Virtual Const void

GetGroupChannels ( TArray< USocialGroupChannel* >& JoinedChannels
)

  
Public function Virtual Const void

GetJoinedChannels ( TArray< USocialChatChannel* >& JoinedChannels
)

  
Protected function Const IOnlineChatPtr END KIAROS GROUP MANAGEMENT.
Protected function Const IOnlineGroupsPtr  
Public function Const USocialToolkit &  
Protected function Virtual void

HandleChatPrivateMessageReceived ( const FUniqueNetId& LocalUserId,
const TSharedRef< FChatMessage >& ChatMessage
)

  
Protected function Virtual void

HandleChatPrivateMessageSent ( const FUniqueNetId& LocalUserId,
const FUniqueNetId& RecipientId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function void

HandleChatRoomConfigured ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function Virtual void

HandleChatRoomConfiguredFailure ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FString& Error
)

  
Protected function void

HandleChatRoomCreated ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function Virtual void

HandleChatRoomCreatedFailure ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FString& Error
)

 Failure handlers (called by HandleXXX functions above)
Protected function void

HandleChatRoomExit ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function Virtual void

HandleChatRoomExitFailure ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FString& Error
)

  
Protected function void

HandleChatRoomJoinPrivate ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function Virtual void

HandleChatRoomJoinPrivateFailure ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FString& Error
)

  
Protected function void

HandleChatRoomJoinPublic ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function Virtual void

HandleChatRoomJoinPublicFailure ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FString& Error
)

  
Protected function void

HandleChatRoomMemberExit ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FUniqueNetId& MemberId
)

  
Protected function void

HandleChatRoomMemberJoin ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FUniqueNetId& MemberId
)

  
Protected function void

HandleChatRoomMemberUpdate ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
const FUniqueNetId& MemberId
)

  
Protected function Virtual void

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

  
Protected function Virtual void

HandleChatRoomMessageSent ( const FUniqueNetId& LocalUserId,
const FChatRoomId& RoomId,
bool bWasSuccessful,
const FString& Error
)

  
Protected function Virtual void  
Protected function Virtual void DECLARE_EVENT_OneParam(USocialChatManager, FOnChatChannelFocusRequested, USocialChatChannel&); FOnChatChannelFocusRequested& OnGroupsChanged() const { return OnChannelFocusRequestedEvent; }
Public function Virtual Const bool  
Protected function Const bool

IsUniqueIdOfOwner ( const FUniqueNetId& LocalUserId
)

  
Public function Virtual void

JoinChatRoomPrivate ( const FChatRoomId& RoomId,
const FChatRoomConfig& InChatRoomConfig,
ESocialSubsystem InSocialSubsystem
)

  
Public function Virtual void

JoinChatRoomPublic ( const FChatRoomId& RoomId,
const FChatRoomConfig& InChatRoomConfig,
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  
Public function Virtual Const FOnChatChannelCreated &  
Protected function Virtual void  
Public function Const FOnChatChannelDisplayRequested &  
Public function Const FOnChatChannelFocusRequested &  
Public function Virtual Const FOnChatChannelLeft &  
Protected function Virtual void  
Protected function void

OnGroupUpdated ( const FUniqueNetId& GroupId
)

  
Protected function void  
Protected function Virtual ESocialChannelType  

Classes

  Type Name Description
Public class FOnChatChannelCreated    
Public class FOnChatChannelDisplayRequested    
Public class FOnChatChannelFocusRequested    
Public class FOnChatChannelLeft    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page