ChannelProperties.h

// Copyright 2026 Stream.IO, Inc. All Rights Reserved.
 
#pragma once
 
#include "ChannelConfig.h"
#include "CoreMinimal.h"
#include "Member.h"
#include "Message.h"
#include "Request/Channel/ChannelRequestDto.h"
 
#include "ChannelProperties.generated.h"
 
struct FChannelResponseDto;
 
USTRUCT(BlueprintType, meta = (HasNativeMake))
struct STREAMCHAT_API FChannelProperties
{
    GENERATED_BODY()
 
    
    FChannelProperties();
 
    explicit FChannelProperties(const FChannelResponseDto& Dto, UUserManager*);
    explicit FChannelProperties(const FChannelResponseDto& Dto, const TArray<FChannelMemberDto>& InMembers, UUserManager*);
 
    // For initial channel creation
    explicit FChannelProperties(const FString& Type, const FString& Id = TEXT(""), const FString& Team = TEXT(""), const FAdditionalFields& ExtraData = {});
 
    explicit operator FChannelRequestDto() const;
 
    FChannelProperties& SetMembers(const TArray<FString>& UserIds);
    FChannelProperties& SetMembers(const TArray<FMember>&);
    FChannelProperties& SetMembers(const TArray<FUserRef>& Users);
 
    FChannelProperties& SetName(const FString&);
    FChannelProperties& SetImageUrl(const FString&);
 
    void Merge(const FChannelResponseDto&, UUserManager*);
    void Merge(const FChannelResponseDto& Dto, const TArray<FChannelMemberDto>& InMembers, UUserManager*);
    void AppendMembers(const TArray<FChannelMemberDto>& InMembers, UUserManager*);
 
    TOptional<FString> GetName() const;
    TOptional<FString> GetImageUrl() const;
 
    FMember* GetMember(const FUserRef&);
    TArray<FUserRef> GetOtherMemberUsers() const;
 
    UPROPERTY(BlueprintReadWrite, Category = "Stream Chat|Channel Properties")
    FString Type;
 
    UPROPERTY(BlueprintReadWrite, Category = "Stream Chat|Channel Properties")
    FString Id;
 
    UPROPERTY(BlueprintReadOnly, Category = "Stream Chat|Channel Properties")
    FString Cid;
 
    UPROPERTY(BlueprintReadOnly, Category = "Stream Chat|Channel Properties")
    FChannelConfig Config;
 
    UPROPERTY()
    int32 MemberCount = 0;
 
    UPROPERTY(BlueprintReadOnly, Category = "Stream Chat|Channel Properties")
    TArray<FMember> Members;
 
    UPROPERTY(BlueprintReadOnly, Category = "Stream Chat|Channel Properties")
    FTimespan Cooldown = FTimespan::Zero();
 
    UPROPERTY()
    FDateTime CreatedAt = FDateTime{0};
 
    UPROPERTY()
    FDateTime UpdatedAt = FDateTime{0};
 
    UPROPERTY()
    FDateTime DeletedAt = FDateTime{0};
 
    UPROPERTY()
    FDateTime LastMessageAt = FDateTime{0};
 
    UPROPERTY()
    FUserRef CreatedBy;
 
    UPROPERTY()
    bool bDisabled = false;
 
    UPROPERTY()
    bool bFrozen = false;
 
    UPROPERTY()
    bool bHidden = false;
 
    UPROPERTY(BlueprintReadOnly, Category = "Stream Chat|Channel Properties")
    bool bBlocked = false;
 
    UPROPERTY()
    bool bMuted = false;
 
    UPROPERTY()
    FDateTime MuteExpiresAt = FDateTime{0};
 
    UPROPERTY()
    FDateTime HideMessagesBefore = FDateTime{0};
 
    UPROPERTY()
    TArray<FString> OwnCapabilities;
 
    UPROPERTY()
    bool bAutoTranslationEnabled = false;
 
    UPROPERTY()
    FString AutoTranslationLanguage;
 
    UPROPERTY(BlueprintReadWrite, Category = "Stream Chat|Channel Properties", AdvancedDisplay)
    FString Team;
 
    UPROPERTY(BlueprintReadWrite, Category = "Stream Chat|Channel Properties", AdvancedDisplay)
    FAdditionalFields ExtraData;
};
 
UCLASS()
class STREAMCHAT_API UChannelPropertiesBlueprintLibrary final : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintPure, Category = "Stream Chat|Channel Properties", meta = (NativeMakeFunc, DisplayName = "Make Channel Properties (ID)", AdvancedDisplay = "Team,ExtraData", AutoCreateRefTerm = ExtraData))
    static FChannelProperties MakeChannelPropertiesId(const FString& Type, const FString& Id, const FString& Team, const FAdditionalFields& ExtraData);
    UFUNCTION(BlueprintPure, Category = "Stream Chat|Channel Properties", meta = (NativeMakeFunc, DisplayName = "Make Channel Properties (User IDs)", AdvancedDisplay = "Team,ExtraData", AutoCreateRefTerm = ExtraData))
    static FChannelProperties MakeChannelPropertiesUserIds(
        const FString& Type,
        const TArray<FString>& UserIds,
        const FString& Team,
        const FAdditionalFields& ExtraData);
    UFUNCTION(BlueprintPure, Category = "Stream Chat|Channel Properties", meta = (NativeMakeFunc, DisplayName = "Make Channel Properties (Users)", AdvancedDisplay = "Team,ExtraData", AutoCreateRefTerm = ExtraData))
    static FChannelProperties MakeChannelPropertiesUsers(
        const FString& Type,
        const TArray<FUserRef>& Users,
        const FString& Team,
        const FAdditionalFields& ExtraData);
};