Parameters for querying the group timeline. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()

virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
long	maxCount
	Maximum number of records to return.

bool	mostRecentFirst
	Sorted results with most recent timestamp first.

uint64_t	startedOnOrAfter
	Include events that started on or after this UNIX millisecond timestamp.

uint64_t	endedOnOrBefore
	Include events that ended on or after this UNIX millisecond timestamp.

int	onlyDirection
	Include events for this direction.

int	onlyType
	Include events for this type.

bool	onlyCommitted
	Include only committed (not in-progress) events.

std::string	onlyAlias
	Include events for this transmitter alias.

std::string	onlyNodeId
	Include events for this transmitter node ID.

int	onlyTxId
	Include events for this transmission ID.

std::string	sql
	Ignore all other settings for SQL construction and use this query string instead.

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Parameters for querying the group timeline.

Helper C++ class to serialize and de-serialize TimelineQueryParameters JSON

Example:

{
   "endedOnOrBefore": 0,
   "maxCount": 50,
   "mostRecentFirst": true,
   "onlyAlias": "",
   "onlyCommitted": true,
   "onlyDirection": 0,
   "onlyNodeId": "",
   "onlyType": 0,
   "onlyTxId": 0,
   "startedOnOrAfter": 0
}

See also: TODO: Add references

Definition at line 8805 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ TimelineQueryParameters()

AppConfigurationObjects::TimelineQueryParameters::TimelineQueryParameters ( )

inline

Definition at line 8845 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::TimelineQueryParameters::clear ( )

inline

Definition at line 8850 of file ConfigurationObjects.h.

Member Data Documentation

◆ endedOnOrBefore

uint64_t AppConfigurationObjects::TimelineQueryParameters::endedOnOrBefore

Include events that ended on or after this UNIX millisecond timestamp.

Definition at line 8822 of file ConfigurationObjects.h.

◆ maxCount

long AppConfigurationObjects::TimelineQueryParameters::maxCount

Maximum number of records to return.

Definition at line 8813 of file ConfigurationObjects.h.

◆ mostRecentFirst

bool AppConfigurationObjects::TimelineQueryParameters::mostRecentFirst

Sorted results with most recent timestamp first.

Definition at line 8816 of file ConfigurationObjects.h.

◆ onlyAlias

std::string AppConfigurationObjects::TimelineQueryParameters::onlyAlias

Include events for this transmitter alias.

Definition at line 8834 of file ConfigurationObjects.h.

◆ onlyCommitted

bool AppConfigurationObjects::TimelineQueryParameters::onlyCommitted

Include only committed (not in-progress) events.

Definition at line 8831 of file ConfigurationObjects.h.

◆ onlyDirection

int AppConfigurationObjects::TimelineQueryParameters::onlyDirection

Include events for this direction.

Definition at line 8825 of file ConfigurationObjects.h.

◆ onlyNodeId

std::string AppConfigurationObjects::TimelineQueryParameters::onlyNodeId

Include events for this transmitter node ID.

Definition at line 8837 of file ConfigurationObjects.h.

◆ onlyTxId

int AppConfigurationObjects::TimelineQueryParameters::onlyTxId

Include events for this transmission ID.

Definition at line 8840 of file ConfigurationObjects.h.

◆ onlyType

int AppConfigurationObjects::TimelineQueryParameters::onlyType

Include events for this type.

Definition at line 8828 of file ConfigurationObjects.h.

◆ sql

std::string AppConfigurationObjects::TimelineQueryParameters::sql

Ignore all other settings for SQL construction and use this query string instead.

Definition at line 8843 of file ConfigurationObjects.h.

◆ startedOnOrAfter

uint64_t AppConfigurationObjects::TimelineQueryParameters::startedOnOrAfter

Include events that started on or after this UNIX millisecond timestamp.

Definition at line 8819 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members