Longbridge OpenAPI C++ SDK
Public Attributes | List of all members
longbridge::alert::AlertItem Struct Reference

One price alert rule attached to a security. More...

#include <types.hpp>

Public Attributes

std::string id
 Alert ID. More...
 
std::string indicator_id
 Condition: "1"=price_rise, "2"=price_fall, "3"=pct_rise, "4"=pct_fall. More...
 
bool enabled
 Whether the alert is currently active. More...
 
int32_t frequency
 Trigger frequency: 1=daily, 2=every_time, 3=once. More...
 
int32_t scope
 Scope. More...
 
std::string text
 Human-readable description of the trigger condition. More...
 
std::vector< int32_t > state
 Trigger state flags. More...
 
std::string value_map
 Trigger threshold, serialised as JSON: {"price":"500"} or {"chg":"5"}. More...
 

Detailed Description

One price alert rule attached to a security.

Member Data Documentation

◆ enabled

bool longbridge::alert::AlertItem::enabled

Whether the alert is currently active.

◆ frequency

int32_t longbridge::alert::AlertItem::frequency

Trigger frequency: 1=daily, 2=every_time, 3=once.

◆ id

std::string longbridge::alert::AlertItem::id

Alert ID.

◆ indicator_id

std::string longbridge::alert::AlertItem::indicator_id

Condition: "1"=price_rise, "2"=price_fall, "3"=pct_rise, "4"=pct_fall.

◆ scope

int32_t longbridge::alert::AlertItem::scope

Scope.

◆ state

std::vector<int32_t> longbridge::alert::AlertItem::state

Trigger state flags.

◆ text

std::string longbridge::alert::AlertItem::text

Human-readable description of the trigger condition.

◆ value_map

std::string longbridge::alert::AlertItem::value_map

Trigger threshold, serialised as JSON: {"price":"500"} or {"chg":"5"}.


The documentation for this struct was generated from the following file: