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

A Stream Chat user. More...

#include <User.h>

Public Member Functions

 FUser ()
 Needed by USTRUCT system. Shouldn't be used directly.
 
 FUser (const FString &InId)
 Create a new sparsely-identified user for local use.
 
 FUser (const FUserDto &)
 Convert from User.
 
 FUser (const FUserObjectDto &)
 Convert from UserObject.
 
 operator FUserDto () const
 Convert to UserDto.
 
 operator FUserObjectDto () const
 Convert to UserObjectDto.
 
 operator FUserObjectRequestDto () const
 Convert to UserObjectRequestDto.
 
void Update (const FUser &User)
 
const FString & GetNameOrId () const
 
FString GetInitials (int32 Limit=2) const
 Generate initials from the user's name.
 
const FDateTime & GetLastActive () const
 Return best value for when the user was last active.
 
FText GetLastSeenText () const
 e.g. Last seen 10 minutes ago
 

Public Attributes

FString Id
 The id of this user.
 
bool bOnline = false
 Whether a user is online or not.
 
bool bInvisible = false
 When invisible is set to true, the current user will appear as offline to other users.
 
FDateTime CreatedAt = FDateTime{0}
 Date/time of creation.
 
FDateTime UpdatedAt = FDateTime{0}
 Date/time of the last update.
 
FDateTime DeactivatedAt = FDateTime{0}
 Date/time of deactivation.
 
FDateTime DeletedAt = FDateTime{0}
 Date/time of deletion.
 
FDateTime LastActive = FDateTime{0}
 Date of last activity.
 
FDateTime BanExpires = FDateTime{0}
 Expiration date of the ban.
 
bool bBanned = false
 Whether a user is banned or not.
 
FString Language
 Preferred language of a user.
 
FDateTime RevokeTokensIssuedBefore = FDateTime{0}
 Revocation date for tokens.
 
FString Role
 Determines the set of user permissions.
 
TArray< FString > Teams
 List of teams user is a part of.
 
FString Name
 The human-readable name of the user.
 
FString Image
 The URL of a profile picture of the user.
 

Detailed Description

A Stream Chat user.


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