Stream Chat Unreal SDK
Loading...
Searching...
No Matches
ChannelSortOption.h
1// Copyright 2022 Stream.IO, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6
7#include "ChannelSortOption.generated.h"
8
10
15UENUM(BlueprintType)
16enum class ESortDirection : uint8
17{
18 Ascending,
19 Descending
20};
21
26UENUM(BlueprintType)
27enum class EChannelSortField : uint8
28{
29 LastUpdated,
30 LastMessageAt,
31 UpdatedAt,
32 CreatedAt,
33 MemberCount,
34 UnreadCount,
35 HasUnread,
36};
37
42USTRUCT(BlueprintType)
44{
45 GENERATED_BODY()
46
47
48 explicit operator FSortParamRequestDto() const;
49
51 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
52 EChannelSortField Field = EChannelSortField::LastMessageAt;
53
55 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
56 ESortDirection Direction = ESortDirection::Descending;
57};
58
63UENUM(BlueprintType)
64enum class EMessageSortField : uint8
65{
67 Id,
69 Text,
71 Type,
83 UserId,
85 CreatedAt,
87 UpdatedAt,
89 Pinned,
91 Custom,
92};
93
98USTRUCT(BlueprintType)
100{
101 GENERATED_BODY()
102
103
104 explicit operator FSortParamRequestDto() const;
105
107 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
109
111 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
112 FName CustomField;
113
115 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
116 ESortDirection Direction = ESortDirection::Descending;
117};
118
123UENUM(BlueprintType)
124enum class EUserSortField : uint8
125{
127 Id,
129 CreatedAt,
131 UpdatedAt,
135 Custom,
136};
137
142USTRUCT(BlueprintType)
144{
145 GENERATED_BODY()
146
147
148 explicit operator FSortParamRequestDto() const;
149
151 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
152 EUserSortField Field = EUserSortField::CreatedAt;
153
155 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
156 ESortDirection Direction = ESortDirection::Descending;
157
159 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
160 FName CustomField;
161};
162
167UENUM(BlueprintType)
168enum class EBanSortField : uint8
169{
173 UserId,
175 Expired,
177 CreatedAt,
180};
181
186USTRUCT(BlueprintType)
188{
189 GENERATED_BODY()
190
191
192 explicit operator FSortParamRequestDto() const;
193
195 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
196 EBanSortField Field = EBanSortField::CreatedAt;
197
199 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Stream Chat")
200 ESortDirection Direction = ESortDirection::Descending;
201};
EUserSortField
The desired sort field for user queries.
Definition: ChannelSortOption.h:125
ESortDirection
The desired sort direction for Stream Chat API queries.
Definition: ChannelSortOption.h:17
EMessageSortField
The desired sort field for message queries.
Definition: ChannelSortOption.h:65
EChannelSortField
The desired sort field for Channel API queries.
Definition: ChannelSortOption.h:28
EBanSortField
The desired sort field for ban queries.
Definition: ChannelSortOption.h:169
@ LastActive
When the user was last active.
@ Pinned
Whether the message has been pinned,.
@ UserId
The user ID of the user that sent the message.
@ Id
Message ID.
@ Attachments
Whether or not the message contains an attachment.
@ Custom
Any custom field that is attached to your message. Must fill CustomField.
@ MentionedUsersId
The user ID that is included in the messages's mentions.
@ Text
Text of the message.
@ Type
Type of the message.
@ ParentId
The parent message ID (if the message is a reply)
@ AttachmentsType
The type of the attachment.
@ ReplyCount
The number of replies the message has.
@ Expired
The date of the ban expiration.
@ BannedById
The ID of the user that created the ban.
@ ChannelCid
The channel CID for the ban. When this parameter is not provided, both global and channel bans will b...
The desired sort options for ban queries.
Definition: ChannelSortOption.h:188
The desired sort options for Channel API queries.
Definition: ChannelSortOption.h:44
The desired sort options for message queries.
Definition: ChannelSortOption.h:100
#/components/schemas/SortParamRequest
Definition: SortParamRequestDto.h:15
The desired sort options for user queries.
Definition: ChannelSortOption.h:144