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

Contains information about a member of a chat channel. More...

#include <Member.h>

Public Member Functions

 FMember ()
 Needed by USTRUCT system. Shouldn't be used directly.
 
 FMember (const FUserRef &User)
 Create a member from a user.
 
 FMember (const FChannelMemberDto &, UUserManager *)
 Create a member from a DTO from the API.
 
bool operator== (const FUserRef &) const
 
bool operator== (const FMember &) const
 
bool IsInvitePending () const
 Has this member been invited to the channel and not yet answered?
 
bool HasAcceptedInvite () const
 Has this member accepted their invitation to the channel?
 
bool HasRejectedInvite () const
 Has this member rejected their invitation to the channel?
 

Public Attributes

FUserRef User
 The user information of this member.
 
FDateTime BanExpires = FDateTime{0}
 Expiration date of the ban.
 
bool bBanned = false
 Whether member is banned in this channel or not.
 
FString ChannelRole
 Role of the member in the channel.
 
FDateTime CreatedAt = FDateTime{0}
 When this user became a member of the channel.
 
FDateTime UpdatedAt = FDateTime{0}
 When this membership was last updated.
 
bool bInvited = false
 Whether this member was invited to the channel, rather than simply added to it.
 
FDateTime InviteAcceptedAt = FDateTime{0}
 When this member accepted their invitation. Zero if they never did.
 
FDateTime InviteRejectedAt = FDateTime{0}
 When this member rejected their invitation. Zero if they never did.
 
bool bIsModerator = false
 Whether this member can moderate the channel.
 
bool bShadowBanned = false
 Whether this member is shadow banned in this channel.
 
bool bNotificationsMuted = false
 Whether this member muted notifications from the channel.
 
FDateTime ArchivedAt = FDateTime{0}
 When this member archived the channel for themselves. Zero if they have not.
 
FDateTime PinnedAt = FDateTime{0}
 When this member pinned the channel for themselves. Zero if they have not.
 
FAdditionalFields ExtraData
 Any custom fields set on the membership.
 

Friends

uint32 GetTypeHash (const FMember &M)
 

Detailed Description

Contains information about a member of a chat channel.

Member Function Documentation

◆ IsInvitePending()

bool FMember::IsInvitePending ( ) const

Has this member been invited to the channel and not yet answered?

Both answers are recorded as a date, so an invite is outstanding only while neither is set. Show such a member an accept/reject prompt rather than the channel itself.

Member Data Documentation

◆ bShadowBanned

bool FMember::bShadowBanned = false

Whether this member is shadow banned in this channel.

Their messages arrive marked as shadowed for everybody else, and not at all for a client which hides them. They are not told about any of this, which is the point.


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