chat_user_local::get_effective_communication_relationship

Artikel
06/22/2023

Gets the communication relationship that Game Chat is enforcing between the local user and a target user.

Syntax

void get_effective_communication_relationship(  
    chat_user* targetUser,  
    game_chat_communication_relationship_flags* effectiveCommunicationRelationship,  
    game_chat_communication_relationship_adjuster* communicationRelationshipAdjuster  
)

Parameters

targetUser _In_
Type: chat_user*

The target user.

effectiveCommunicationRelationship _Out_
Type: game_chat_communication_relationship_flags*

The communication relationship that Game Chat is enforcing.

communicationRelationshipAdjuster _Out_
Type: game_chat_communication_relationship_adjuster*

The adjuster being applied to the communication relationship set by the title. If effectiveCommunicationRelationship is different from what was set, this indicates why.

Return value

Type: void

Remarks

The direction of the relationship is such that it can be described as "the local user can perform actions defined by communicationRelationship in relation to targetUser." E.g. if communicationRelationship is receive_only that means "this local user can receive communications from targetUser, but the local user cannot send communications to targetUser". The communication relationship that Game Chat enforces for a pair of users can be different from what was set by the title because Game Chat performs extra adjustments based on privilege, privacy, and reputation.

Requirements

Header: GameChat2.h

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