Stream Chat Unreal SDK
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
FFilter Struct Reference
Stream Chat

A filter used for querying channels. More...

#include <Filter.h>

Public Member Functions

 FFilter ()=default
 Needed by USTRUCT system. Shouldn't be used directly.
 
FJsonObjectWrapper ToJsonObjectWrapper () const
 Convert to a JSON object wrapper.
 
FString ToJson () const
 Convert to a JSON string.
 
TSharedRef< FJsonObject > ToJsonObject () const
 Convert to a JSON object.
 
bool IsValid () const
 Check if this filter has been correctly initialized.
 

Static Public Member Functions

static FFilter And (const TArray< FFilter > &Filters)
 Construct an $and filter.
 
static FFilter Or (const TArray< FFilter > &Filters)
 Construct an $or filter.
 
static FFilter Nor (const TArray< FFilter > &Filters)
 Construct a $nor filter.
 
static FFilter Equal (const FName &Field, int32 Value)
 Construct an $eq filter.
 
static FFilter Equal (const FName &Field, float Value)
 Construct an $eq filter.
 
static FFilter Equal (const FName &Field, const TCHAR *Value)
 Construct an $eq filter.
 
static FFilter Equal (const FName &Field, const FString &Value)
 Construct an $eq filter.
 
static FFilter Equal (const FName &Field, bool bValue)
 Construct an $eq filter.
 
static FFilter Equal (const FName &Field, TYPE_OF_NULLPTR)
 Construct an $eq filter.
 
static FFilter NotEqual (const FName &Field, int32 Value)
 Construct a $neq filter.
 
static FFilter NotEqual (const FName &Field, float Value)
 Construct a $neq filter.
 
static FFilter NotEqual (const FName &Field, const TCHAR *Value)
 Construct a $neq filter.
 
static FFilter NotEqual (const FName &Field, const FString &Value)
 Construct a $neq filter.
 
static FFilter NotEqual (const FName &Field, bool bValue)
 Construct a $neq filter.
 
static FFilter NotEqual (const FName &Field, TYPE_OF_NULLPTR)
 Construct a $neq filter.
 
static FFilter Greater (const FName &Field, int32 Value)
 Construct a $gt filter.
 
static FFilter Greater (const FName &Field, float Value)
 Construct a $gt filter.
 
static FFilter Greater (const FName &Field, const FString &Value)
 Construct a $gt filter.
 
static FFilter GreaterOrEqual (const FName &Field, int32 Value)
 Construct a $gte filter.
 
static FFilter GreaterOrEqual (const FName &Field, float Value)
 Construct a $gte filter.
 
static FFilter GreaterOrEqual (const FName &Field, const FString &Value)
 Construct a $gte filter.
 
static FFilter Less (const FName &Field, int32 Value)
 Construct a $lt filter.
 
static FFilter Less (const FName &Field, float Value)
 Construct a $lt filter.
 
static FFilter Less (const FName &Field, const FString &Value)
 Construct a $lt filter.
 
static FFilter LessOrEqual (const FName &Field, int32 Value)
 Construct a $lte filter.
 
static FFilter LessOrEqual (const FName &Field, float Value)
 Construct a $lte filter.
 
static FFilter LessOrEqual (const FName &Field, const FString &Value)
 Construct a $lte filter.
 
static FFilter In (const FName &Field, const TArray< int32 > &Values)
 Construct an $in filter.
 
static FFilter In (const FName &Field, const TArray< float > &Values)
 Construct an $in filter.
 
static FFilter In (const FName &Field, const TArray< FString > &Values)
 Construct an $in filter.
 
static FFilter NotIn (const FName &Field, const TArray< int32 > &Values)
 Construct an $in filter.
 
static FFilter NotIn (const FName &Field, const TArray< float > &Values)
 Construct an $nin filter.
 
static FFilter NotIn (const FName &Field, const TArray< FString > &Values)
 Construct an $nin filter.
 
static FFilter Exists (const FName &Field, bool bValue)
 Construct an $exists filter.
 
static FFilter Autocomplete (const FName &Field, const FString &Value)
 Construct an $autocomplete filter.
 
static FFilter Empty (const FName &Field)
 Construct an empty filter, e.g. {field:{}}.
 

Detailed Description

A filter used for querying channels.

See also
https://getstream.io/chat/docs/unreal/query_channels
The documentation for this struct was generated from the following files: