SmartFoxServer 3 C++ Client API 3.1.0-beta
Client API for SmartFoxServer 3
Loading...
Searching...
No Matches
sfs3::entities::match::MatchExpression::Condition Struct Reference

A single condition of a matching expression. More...

#include <MatchExpression.h>

Public Attributes

std::optional< LogicOperatorlogicOp
 The logical operator joining this condition to the ones before it.
std::string varName
 The name of the variable or property against which the comparison is made.
MatcherType matcherType
 The kind of comparison performed, which also determines the alternative held by value.
const char * symbol
 The condition symbol, e.g.
Value value
 The value the variable or property is compared against.

Detailed Description

A single condition of a matching expression.

Member Data Documentation

◆ logicOp

std::optional<LogicOperator> sfs3::entities::match::MatchExpression::Condition::logicOp

The logical operator joining this condition to the ones before it.

Empty on the first condition of the expression, which nothing precedes.

◆ varName

std::string sfs3::entities::match::MatchExpression::Condition::varName

The name of the variable or property against which the comparison is made.

Depending on what the matching expression is used for (searching a user or a Room), this can be the name of a User Variable or a Room Variable, or it can be one of the constants in UserProperties or RoomProperties.

◆ symbol

const char* sfs3::entities::match::MatchExpression::Condition::symbol

The condition symbol, e.g.

"==" or "startsWith".

Always points to a string literal with static storage duration, so it stays valid for as long as the program runs and is safe to copy around.


The documentation for this struct was generated from the following file:
  • entities/match/MatchExpression.h