Stream Chat Unreal SDK
Loading...
Searching...
No Matches
FUserRef Struct Reference

A reference to a unique User. More...

#include <UserRef.h>

Public Member Functions

 FUserRef ()
 Needed by USTRUCT system. Shouldn't be used directly.
 
const FUserGetUser () const
 Access the underlying user.
 
const FUseroperator* () const
 Access the underlying user.
 
const FUseroperator-> () const
 Access the underlying user.
 
bool operator== (const FUserRef &) const
 Do these reference the same user?
 
bool operator!= (const FUserRef &) const
 Do these reference different users?
 
bool IsValid () const
 Will dereferencing this yield a valid user?
 
bool IsCurrent () const
 Is this user the currently logged-in local user?
 
FUserUpdatedMultiDelegate & OnUpdate () const
 

Protected Attributes

FString UserId
 

Friends

uint32 GetTypeHash (const FUserRef &U)
 

Detailed Description

A reference to a unique User.

All users are stored once in a central location (UserManager). This struct can be copied around freely and then dereferenced when the real user information is required. This struct also provides access to a delegate which can be used to be informed of underlying user updates.

Member Function Documentation

◆ OnUpdate()

FUserUpdatedMultiDelegate & FUserRef::OnUpdate ( ) const

Get a delegate which can be be used to be informed of the user's updates. The delegate is guaranteed to be unique to the underlying user.


The documentation for this struct was generated from the following files: