CloudConfigUpdateFunction Class Reference

Update configuration via Particle function call. More...

#include <CloudConfigRK.h>

Inheritance diagram for CloudConfigUpdateFunction:

Public Member Functions
	CloudConfigUpdateFunction ()
	Default constructor.
	CloudConfigUpdateFunction (const char *name)
	Constructor with function name. More...
CloudConfigUpdateFunction &	withName (const char *name)
	Method to set the name of the Particle.function to register. More...
virtual void	setup ()
	Called during setup() More...
int	functionHandler (String param)
	Function that is called when the Particle.function is called.
Public Member Functions inherited from CloudConfigUpdate
	CloudConfigUpdate ()
	Default constructor.
virtual void	loop ()
	Called during loop() to allow update methods to have loop time. More...
virtual void	startUpdate ()
	Called when subclasses should update the data from the cloud. More...

Protected Attributes
String	name
	Function name passed to constructor or withName. Used during setup().

Additional Inherited Members
Data Fields inherited from CloudConfigUpdate
unsigned long	waitAfterCloudConnectedMs = 2000
	How long to wait after cloud connected to update settings.
unsigned long	updateTimeoutMs = 60000
	If a response is not received in this amount of time, an error is assumed and another attempt will be made later. More...
Protected Member Functions inherited from CloudConfigUpdate
virtual	~CloudConfigUpdate ()
	Destructor. Base class destructor is empty. Also, you can't delete one of these.
	CloudConfigUpdate (const CloudConfigUpdate &)=delete
	This class is not copyable.
CloudConfigUpdate &	operator= (const CloudConfigUpdate &)=delete
	This class is not copyable.

Detailed Description

Update configuration via Particle function call.

Function update is a good choice if:

• You will be pushing the changes from your own server.
• Each device has its own configuration.
• You want confirmation that the device received the update.
• The device may be in sleep mode or offline.
• You are using unclaimed product devices (also works if claimed).

Constructor & Destructor Documentation

CloudConfigUpdateFunction()

CloudConfigUpdateFunction::CloudConfigUpdateFunction ( const char *  name )

inline

Constructor with function name.

Parameters

name	The name of the function to register

Member Function Documentation

setup()

void CloudConfigUpdateFunction::setup ( )

virtual

Called during setup()

Be sure to set the name before calling setup()!

Reimplemented from CloudConfigUpdate.

withName()

CloudConfigUpdateFunction& CloudConfigUpdateFunction::withName ( const char *  name )

inline

Method to set the name of the Particle.function to register.

Parameters

name	The name of the function to register

This must be called before setup(). Calling it later will have no effect.

---

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

• src/CloudConfigRK.h
• src/CloudConfigRK.cpp