FChannelProperties Struct Reference

Encapsulates the static properties of a channel. More...

#include <ChannelProperties.h>

Public Member Functions
	FChannelProperties ()
	Needed by USTRUCT system. Shouldn't be used directly.
	FChannelProperties (const FChannelResponseDto &Dto, UUserManager *)
	Create channel properties from a DTO from the API.
	FChannelProperties (const FChannelResponseDto &Dto, const TArray< FChannelMemberDto > &InMembers, UUserManager *)
	FChannelProperties (const FString &Type, const FString &Id=TEXT(""), const FString &Team=TEXT(""), const FAdditionalFields &ExtraData={})
	operator FChannelRequestDto () const
	Convert to a channel request DTO to send to the API.
FChannelProperties &	SetMembers (const TArray< FString > &UserIds)
	Set the members using just their User IDs.
FChannelProperties &	SetMembers (const TArray< FMember > &)
FChannelProperties &	SetMembers (const TArray< FUserRef > &Users)
	Set the members using a list of Users.
FChannelProperties &	SetName (const FString &)
FChannelProperties &	SetImageUrl (const FString &)
void	Merge (const FChannelResponseDto &, UUserManager *)
	Merge new information from the API into this properties, retaining members.
void	Merge (const FChannelResponseDto &Dto, const TArray< FChannelMemberDto > &InMembers, UUserManager *)
	Merge new information from the API into this properties, replacing members.
void	AppendMembers (const TArray< FChannelMemberDto > &InMembers, UUserManager *)
	Append new members, skipping duplicates.
TOptional< FString >	GetName () const
TOptional< FString >	GetImageUrl () const
FMember *	GetMember (const FUserRef &)
TArray< FUserRef >	GetOtherMemberUsers () const
	Get user information of channel members other than the currently logged-in user.

Public Attributes
FString	Type
FString	Id
FString	Cid
	The cid of this channel.
FChannelConfig	Config
	Configuration of the channel (usually set via the dashboard)
int32	MemberCount = 0
	The count of the members of this channel.
TArray< FMember >	Members
	The members of this channel.
FTimespan	Cooldown = FTimespan::Zero()
	Cooldown period after sending each message. No cooldown if zero.
FDateTime	CreatedAt = FDateTime{0}
	The date of channel creation.
FDateTime	UpdatedAt = FDateTime{0}
	The date of the last channel update.
FDateTime	DeletedAt = FDateTime{0}
	The date of channel deletion.
FDateTime	LastMessageAt = FDateTime{0}
	The date of the last message.
FUserRef	CreatedBy
	The user that created this channel.
bool	bDisabled = false
bool	bFrozen = false
	Whether this channel is frozen or not.
bool	bHidden = false
	Whether this channel is hidden by current user or not.
bool	bMuted = false
	Whether this channel is muted or not.
FDateTime	MuteExpiresAt = FDateTime{0}
	Date of mute expiration.
FDateTime	HideMessagesBefore = FDateTime{0}
	Date since when the message history is accessible.
TArray< FString >	OwnCapabilities
	List of channel capabilities of the authenticated user.
bool	bAutoTranslationEnabled = false
	Whether auto translation is enabled or not.
FString	AutoTranslationLanguage
	Language to translate to when auto translation is active.
FString	Team
	The team the channel belongs to (multi-tenant only)
FAdditionalFields	ExtraData
	Extra data for this channel.

Detailed Description

Encapsulates the static properties of a channel.

Member Data Documentation

Id

FString FChannelProperties::Id

An identifier for this channel. Not globally unique. A subset of the Cid. Auto-generated if members are specified

Type

FString FChannelProperties::Type

Type of channel, either built-in or custom Default types are livestream, messaging, team, gaming and commerce. You can also create your own types.

See also

https://getstream.io/chat/docs/unreal/channel_features/

---

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

• Source/StreamChat/Public/Channel/ChannelProperties.h
• Source/StreamChat/Private/Channel/ChannelProperties.cpp