GameChatOverlay Class

Definition

public ref class GameChatOverlay sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class GameChatOverlay final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class GameChatOverlay

Public NotInheritable Class GameChatOverlay

Inheritance

Object Platform::Object IInspectable GameChatOverlay

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Examples

This sample demonstrates setting up game chat and adding text messages to it.

#include <winrt/Windows.Gaming.UI.h>
using namespace winrt;
using namespace Windows::Gaming::UI;
...
GameChatOverlay m_gameChatOverlay{nullptr};
...
void ChatSample::SetUpGameChat(GameChatOverlayPosition position)
{
 // Get the default game chat overlay object. Platforms that don't support
 // it will return null.
 m_gameChatOverlay = GameChatOverlay::GetDefault();

 if (m_gameChatOverlay)
 {
 // Position the overlay in the given position.
 m_gameChatOverlay.DesiredPosition(position);
 }
}

// This method typically would be wired to a text entry box in order to send
// text messages.
void ChatSample::SendTextMessage(std::wstring gamertag, std::wstring message)
{
 if (m_gameChatOverlay)
 {
 // Render the text in the overlay.
 m_gameChatOverlay.AddMessage(
 gamertag,
 message,
 GameChatMessageOrigin::Text);
 }
 else
 {
 // The game should render the outgoing message in its own UI.
 }
}

void ChatSample::SetUpGameChat(GameChatOverlayPosition position)
{
 // Get the default game chat overlay object. Platforms that don't support
 // it will return null.
 m_gameChatOverlay = GameChatOverlay::GetDefault();

 if (m_gameChatOverlay)
 {
 // Position the overlay in the given position.
 m_gameChatOverlay->DesiredPosition = position;
 }
}

// This method typically would be wired to a text entry box in order to send
// text messages.
void ChatSample::SendTextMessage(String^ gamertag, String^ message) 
{
 if (m_gameChatOverlay)
 {
 // Render the text in the overlay.
 m_gameChatOverlay->AddMessage(
 gamertag, 
 message, 
 GameChatMessageOrigin::Text);
 }
 else 
 { 
 // The game should render the outgoing message in its own UI.
 } 
}

Remarks

This class provides methods to get the default game chat overlay instance, set the desired position of the overlay, and add messages to it.

See also

• GameChatOverlayPosition