chat_manager::add_local_user

Artikel
06/22/2023

Adds a local user to the local chat_manager instance.

Syntax

chat_user* add_local_user(  
    PCWSTR xboxUserId  
)

Parameters

xboxUserId _In_
Type: PCWSTR

The Xbox User ID of the local user to add.

Return value

Type: chat_user*

Remarks

All local users added to the Game Chat 2 instance need to be added with XUserAddAsync first.

The user will be added unconditionally, unless the total number of local and remote users is equal to the max user count that was indicated in chat_manager::initialize().

The return value is a pointer to the chat_user object associated with this user. If the Xbox User ID is invalid, the user's chat_indicator value will be game_chat_user_chat_indicator::platform_restricted.

A typical pattern would be:

chat_user* newLocalChatUser = chat_manager::singleton_instance().add_local_user(&amp;lt;local_user_xuid&amp;gt;);

size_t chatUserCount; 
chat_user_array chatUsers; 
chat_manager::singleton_instance().get_remote_chat_users(&chatUserCount, &chatUsers); 
for (uint32_t chatUserIndex = 0; chatUserIndex < chatUsercount; ++chatUserIndex) 
{ 
    chat_user* chatUser = chatUsers[chatUserIndex]; 
    game_chat_communication_relationship_flags relationship = game_chat_communication_relationship_flags::none; 
    if (chatUser can send and receive to/from newLocalChatUser) 
    { 
        relationship = c_communicationRelationshipSendAndReceiveAll; 
    } 
    else if (chatUser can send to newLocalChatUser) 
    { 
        relationship = c_communicationRelationshipSendAll; 
    } 
    else if (chatUser can receive from newLocalChatUser) 
    { 
        relationship = c_communicationRelationshipReceiveAll; 
    } 

    newLocalChatUser->set_communication_relationship(chatUser, relationship); 
}

Requirements

Header: GameChat2.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles