SleepHelper
Public Member Functions | Data Fields
SleepHelper::PublishData Class Reference

Class to hold data to be published by Particle.publish. More...

#include <SleepHelper.h>

Public Member Functions

 PublishData ()
 Initialize empty object.
 
 PublishData (const char *eventName)
 Initialize object with event name, no data payload, and default flags. More...
 
 PublishData (const char *eventName, const char *eventData)
 Initialize object with event name, event data, and default flags. More...
 
 PublishData (const char *eventName, const char *eventData, PublishFlags flags)
 Initialize object with event name, event data, and flags. More...
 

Data Fields

String eventName
 Particle event name.
 
String eventData
 Particle event payload.
 
PublishFlags flags = PRIVATE
 Flags. Default is PRIVATE, can also use NO_ACK.
 

Detailed Description

Class to hold data to be published by Particle.publish.

Constructor & Destructor Documentation

◆ PublishData() [1/3]

SleepHelper::PublishData::PublishData ( const char *  eventName)
inline

Initialize object with event name, no data payload, and default flags.

Parameters
eventNameEvent name (64 characters maximum)

◆ PublishData() [2/3]

SleepHelper::PublishData::PublishData ( const char *  eventName,
const char *  eventData 
)
inline

Initialize object with event name, event data, and default flags.

Parameters
eventNameEvent name (64 characters maximum)
eventDataEvent data (typically 1024 characters, but may be less in some cases)

◆ PublishData() [3/3]

SleepHelper::PublishData::PublishData ( const char *  eventName,
const char *  eventData,
PublishFlags  flags 
)
inline

Initialize object with event name, event data, and flags.

Parameters
eventNameEvent name (64 characters maximum)
eventDataEvent data (typically 1024 characters, but may be less in some cases)
flagsFlags such as PRIVATE or NO_ACK

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