Stream Chat

This module is the main interface to the Stream Chat low level client functionality. More...

Classes
struct	FAttachment
	A file, image or link attached to a message. More...
struct	FChannelConfig
	The configuration, permissions and features of a channel, as defined by the "channel type". More...
struct	FChannelProperties
	Encapsulates the static properties of a channel. More...
class	UChannelPropertiesBlueprintLibrary
	Blueprint functions for the Channel Properties struct. More...
struct	FChannelSortOption
	The desired sort options for Channel API queries. More...
struct	FMessageSortOption
	The desired sort options for message queries. More...
struct	FUserSortOption
	The desired sort options for user queries. More...
struct	FThreadSortOption
	The desired sort options for thread queries. More...
struct	FBanSortOption
	The desired sort options for ban queries. More...
struct	FChannelState
	Encapsulates the local state of a channel. More...
class	UChatChannel
	The client-side representation of a Stream Chat channel. More...
struct	FChatThread
	Represents a Stream Chat thread: a message and the replies hanging off it. More...
struct	FFilter
	A filter used for querying channels. More...
struct	FMember
	Contains information about a member of a chat channel. More...
struct	FMessage
	Represents a Stream Chat message. More...
struct	FMessagePaginationOptions
	Options for pagination of messages. More...
struct	FMessageStore
	A store for a list of messages. More...
struct	FRead
	Contains information about the read state (i.e number of unread messages) of a member of a chat channel. More...
struct	FBanPaginationOptions
	Options for pagination of bans. More...
struct	FMessageModeration
	The moderation verdict for a message. More...
struct	FUserBlock
	One user blocking another. More...
struct	FPaginationOptions
	Options for pagination. More...
struct	FReaction
	An individual reaction to a message. More...
struct	FReactionGroup
	An abstraction to group reactions by their type. More...
class	UReactionGroupBlueprintLibrary
	Blueprint functions for the ReactionGroup struct. More...
struct	FReactions
	Encapsulates a collection of reactions for a message. More...
class	UReactionsBlueprintLibrary
	Blueprint functions for the Reactions struct. More...
class	UStreamChatClientComponent
	A component which allows for connecting to the Stream Chat API. Should be added to a client-side actor, e.g. HUD. More...
class	UStreamChatSettings
	Project Settings for Stream Chat. More...
class	UUserBlueprintLibrary
	Blueprint functions for the User struct. More...
struct	FUserPaginationOptions
	Options for pagination of members or watchers. More...
class	UAdditionalFieldsBlueprintLibrary
	Blueprint functions for the Additional Fields struct. More...

Enumerations
enum class	ETokenType : uint8 { ETokenType::Jwt , ETokenType::Anonymous }
	The type of token. More...
enum class	EAttachmentType : uint8 {   EAttachmentType::Unknown , EAttachmentType::Image , EAttachmentType::File , Video ,   Audio , EAttachmentType::Giphy , EAttachmentType::Link }
	What kind of content an attachment holds. More...
enum class	ESortDirection : uint8 { Ascending , Descending }
	The desired sort direction for Stream Chat API queries.
enum class	EChannelSortField : uint8 {   LastUpdated , LastMessageAt , UpdatedAt , CreatedAt ,   MemberCount , UnreadCount , HasUnread }
	The desired sort field for Channel API queries.
enum class	EMessageSortField : uint8 {   EMessageSortField::Id , EMessageSortField::Text , EMessageSortField::Type , EMessageSortField::ParentId ,   EMessageSortField::ReplyCount , EMessageSortField::Attachments , EMessageSortField::AttachmentsType , EMessageSortField::MentionedUsersId ,   EMessageSortField::UserId , EMessageSortField::CreatedAt , EMessageSortField::UpdatedAt , EMessageSortField::Pinned ,   EMessageSortField::Custom }
	The desired sort field for message queries. More...
enum class	EUserSortField : uint8 {   EUserSortField::Id , EUserSortField::CreatedAt , EUserSortField::UpdatedAt , EUserSortField::LastActive ,   EUserSortField::Custom }
	The desired sort field for user queries. More...
enum class	EThreadSortField : uint8 {   EThreadSortField::HasUnread , EThreadSortField::LastMessageAt , EThreadSortField::ParentMessageId , EThreadSortField::CreatedAt ,   EThreadSortField::UpdatedAt , EThreadSortField::ReplyCount , EThreadSortField::ParticipantCount , EThreadSortField::ActiveParticipantCount }
	The desired sort field for thread queries. More...
enum class	EBanSortField : uint8 {   EBanSortField::ChannelCid , EBanSortField::UserId , EBanSortField::Expired , EBanSortField::CreatedAt ,   EBanSortField::BannedById }
	The desired sort field for ban queries. More...
enum class	EFilterOperator : uint8 {   None , EFilterOperator::Equal , EFilterOperator::NotEqual , EFilterOperator::Greater ,   EFilterOperator::GreaterOrEqual , EFilterOperator::Less , EFilterOperator::LessOrEqual , EFilterOperator::In ,   EFilterOperator::NotIn , EFilterOperator::Query , EFilterOperator::Autocomplete , EFilterOperator::Exists ,   EFilterOperator::And , EFilterOperator::Or , EFilterOperator::Nor , EFilterOperator::Contains }
	The type of operator of a filter. More...
enum class	EMessageSendState : uint8 {   None , EMessageSendState::Sending , EMessageSendState::Sent , EMessageSendState::Updating ,   EMessageSendState::Deleting , EMessageSendState::Failed }
	The client-side state of a message. More...
enum class	EMessageType : uint8 {   EMessageType::Regular , EMessageType::Ephemeral , EMessageType::Error , EMessageType::Reply ,   EMessageType::System , EMessageType::Deleted }
	Type of message, as set by the API or chat bots and custom commands. More...
enum class	EMessageModerationAction : uint8 {   EMessageModerationAction::None , EMessageModerationAction::Bounce , EMessageModerationAction::Remove , EMessageModerationAction::Flag ,   EMessageModerationAction::Other }
	What moderation decided to do with a message. More...

Detailed Description

This module is the main interface to the Stream Chat low level client functionality.

Enumeration Type Documentation

EAttachmentType

enum class EAttachmentType : uint8

strong

What kind of content an attachment holds.

Enumerator
Unknown	A type this version of the SDK does not know about. The raw value is kept in FAttachment::RawType.
Image	A still image, rendered inline.
File	Any other uploaded file, offered as a download.
Giphy	A Giphy result, produced by the /giphy command.
Link	A preview the backend generated by scraping a URL in the message text.

EBanSortField

enum class EBanSortField : uint8

strong

The desired sort field for ban queries.

Enumerator
ChannelCid	The channel CID for the ban. When this parameter is not provided, both global and channel bans will be returned.
UserId	The ID of the banned user.
Expired	The date of the ban expiration.
CreatedAt	The date of the ban creation.
BannedById	The ID of the user that created the ban.

EFilterOperator

enum class EFilterOperator : uint8

strong

The type of operator of a filter.

Enumerator
Equal	Matches values that are equal to a specified value.
NotEqual	Matches all values that are not equal to a specified value.
Greater	Matches values that are greater than a specified value.
GreaterOrEqual	Matches values that are greater than a specified value.
Less	Matches values that are less than a specified value.
LessOrEqual	Matches values that are less than or equal to a specified value.
In	Matches any of the values specified in an array.
NotIn	Matches none of the values specified in an array.
Query	Matches values by performing text search with the specified value.
Autocomplete	Matches values with the specified prefix.
Exists	Matches values that exist/don't exist based on the specified boolean value.
And	Matches all the values specified in an array.
Or	Matches at least one of the values specified in an array.
Nor	Matches none of the values specified in an array.
Contains	Matches any list that contains the specified value.

EMessageModerationAction

enum class EMessageModerationAction : uint8

strong

What moderation decided to do with a message.

Enumerator
None	Moderation reached no verdict, which is the case for almost every message.
Bounce	The message needs rephrasing and sending again. It was neither published nor stored.
Remove	The message was blocked and removed from the channel.
Flag	The message was published, but sent to the dashboard for a moderator to review.
Other	An action this version of the SDK does not know about. Read FMessageModeration::RawAction.

EMessageSendState

enum class EMessageSendState : uint8

strong

The client-side state of a message.

Enumerator
Sending	Message is shown, but user might see a "pending" icon.
Sent	Message is shown, and user might see a "confirmed" icon.
Updating	Message is shown, but user might see a "pending" icon.
Deleting	Message might be shown as deleted already, pending confirmation from API.
Failed	User might see a "failed" icon.

EMessageSortField

enum class EMessageSortField : uint8

strong

The desired sort field for message queries.

Enumerator
Id	Message ID.
Text	Text of the message.
Type	Type of the message.
ParentId	The parent message ID (if the message is a reply)
ReplyCount	The number of replies the message has.
Attachments	Whether or not the message contains an attachment.
AttachmentsType	The type of the attachment.
MentionedUsersId	The user ID that is included in the messages's mentions.
UserId	The user ID of the user that sent the message.
CreatedAt	Created at time.
UpdatedAt	Updated at time.
Pinned	Whether the message has been pinned,.
Custom	Any custom field that is attached to your message. Must fill CustomField.

EMessageType

enum class EMessageType : uint8

strong

Type of message, as set by the API or chat bots and custom commands.

See also

https://getstream.io/chat/docs/unreal/message_format/#message-types

Enumerator
Regular	A regular message created in the channel.
Ephemeral	A temporary message which is only delivered to one user. It is not stored in the channel history. Ephemeral messages are normally used by commands (e.g. /giphy) to prompt messages or request for actions.
Error	An error message generated as a result of a failed command. It is also ephemeral, as it is not stored in the channel history and is only delivered to one user.
Reply	A message in a reply thread. Attention The API reports thread replies as Regular, so this does not reliably identify one. Use FMessage::IsThreadReply(), which goes by ParentId, instead.
System	A message generated by a system event, like updating the channel or muting a user.
Deleted	A soft deleted message.

EThreadSortField

enum class EThreadSortField : uint8

strong

The desired sort field for thread queries.

Enumerator
HasUnread	Whether the thread has replies the current user hasn't read.
LastMessageAt	When the most recent reply was sent.
ParentMessageId	The ID of the message which started the thread.
CreatedAt	When the thread was started.
UpdatedAt	When the thread was last updated.
ReplyCount	The number of replies in the thread.
ParticipantCount	The number of users who have ever replied in the thread.
ActiveParticipantCount	The number of users still participating in the thread.

ETokenType

enum class ETokenType : uint8

strong

The type of token.

Enumerator
Jwt	JSON Web Token.
Anonymous	Very restricted user type.

EUserSortField

enum class EUserSortField : uint8

strong

The desired sort field for user queries.

Enumerator
Id	User ID.
CreatedAt	Created at time.
UpdatedAt	Updated at time.
LastActive	When the user was last active.
Custom	Any custom field that is attached to your message. Must fill CustomField.