# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: TextChatMessageProperties
type: class
memory_category: Instances
summary: |
  Overrides `Class.TextChatMessage` properties when returned by callbacks
  defined in `Class.TextChatService.OnIncomingMessage` or
  `Class.TextChannel.OnIncomingMessage`.
description: |
  Overrides `Class.TextChatMessage` properties like
  `Class.TextChatMessage.ChatWindowMessageProperties|ChatWindowMessageProperties`
  and
  `Class.TextChatMessage.BubbleChatMessageProperties|BubbleChatMessageProperties`
  when returned by callbacks defined in
  `Class.TextChatService.OnIncomingMessage` or
  `Class.TextChannel.OnIncomingMessage`. These properties are useful for
  customizing the appearance of a message with
  [rich text](../../../ui/rich-text.md) tags.

  For sample code, see
  [Assign chat tags](../../../chat/examples/group-chat-tags.md).

  If you return empty strings for any of these properties,
  `Class.TextChatService` ignores them and **doesn't** override the original
  values.
code_samples: []
inherits:
  - Instance
descendants:
  - BubbleChatMessageProperties
  - ChatWindowMessageProperties
tags: []
deprecation_message: ''
properties:
  - name: TextChatMessageProperties.PrefixText
    summary: |
      The `Class.TextChatMessage.PrefixText` to override.
    description: |
      The `Class.TextChatMessage.PrefixText` to override.
    code_samples: []
    type: string
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: TextChatMessageProperties.Text
    summary: |
      The `Class.TextChatMessage.Text` to override.
    description: |
      The `Class.TextChatMessage.Text` to override.
    code_samples: []
    type: string
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: TextChatMessageProperties.Translation
    summary: |
      The `Class.TextChatMessage.Translation` to override.
    description: |
      The `Class.TextChatMessage.Translation` to override; represents
      [automatically translated](../../../production/localization/automatic-translations.md)
      and filtered text messages based on players' localization settings.
    code_samples: []
    type: string
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
methods: []
events: []
callbacks: []