TextChannel

Show Deprecated

Represents a text chat channel. Contains TextSources as descendants.

To send a chat message to the TextChannel, call TextChannel:SendAsync() from a LocalScript. The corresponding TextSource of the user with TextSource.CanSend = true must be in that channel.

Messages from different TextChannels can be separated into different tabs in the chat window using ChannelTabsConfiguration.

Summary

DirectChatRequester:Player
Read Only
Not Replicated
Read Parallel
The TextChannel will only deliver messages to users that can send direct messages to the DirectChatRequester.

AddUserAsync(userId : number):Tuple
Yields
Adds a TextSource to the TextChannel given userId of a Player.
DisplaySystemMessage(systemMessage : string,metadata : string):TextChatMessage
Displays a system message to the user.
SendAsync(message : string,metadata : string):TextChatMessage
Yields
Sends a TextChatMessage to the server.
SetDirectChatRequester(requester : Player):()
Sets the DirectChatRequester for the TextChannel. The TextChannel will only deliver messages to users that can send direct messages to the DirectChatRequester.

MessageReceived(incomingMessage : TextChatMessage):RBXScriptSignal
Fires when TextChannel:DisplaySystemMessage() is invoked on the client, or when the client receives a valid TextChannel:SendAsync() response from the server.

OnIncomingMessage(message : TextChatMessage):Tuple
Called when TextChannel is receiving an incoming message.
ShouldDeliverCallback(message : TextChatMessage,textSource : TextSource):Tuple
Called for each client when TextChannel is receiving an incoming message to determine whether or not it should be delivered to that client.