2121#include " FirebaseObject.h"
2222
2323/* *
24- *Gateway class for Arduino clients to interact withthe Firebase backend .
24+ *Main class for Arduino clients to interact with Firebase.
2525 * This implementation is designed to follow Arduino best practices and favor
26- * simplicity over all else. For more complicated usecases and more control
27- * see the Firebase class in Firebase.h.
26+ * simplicity over all else.
27+ * For more complicated usecases and more control see the Firebase class in
28+ * Firebase.h.
2829*/
2930class FirebaseArduino {
3031public:
3132/* *
32- * Must be called first. This sets the class up for use.
33- * \param host Your firebase db server domain name, usually X.firebaseIO.com.
34- * \param auth Optional authentication for the db, a Secret or Token.
33+ * Must be called first. This initialize the client with the given
34+ * firebase host and credentials.
35+ * \param host Your firebase db host, usually X.firebaseio.com.
36+ * \param auth Optional credentials for the db, a secret or token.
3537*/
3638void begin (const char * host,const char * auth =" "
3739
3840/* *
39- *Adds the datain value to the list located at path.Equivilent to the
40- * REST API's POST.
41+ *Writes datato a new child location under the parent at path.
42+ *Equivalent to the REST API's POST.
4143 * You should check success() after calling.
42- * \param path The path inside of your db to thelist you wish to update .
43- * \param value Data that you wish to addto thelist .
44- * \return The childname where the data was written.
44+ * \param path The path inside of your db to theparent object .
45+ * \param value Data that you wish to addunder theparent .
46+ * \return Theunique childkey where the data was written.
4547*/
4648 Stringpush (const String& path,const JsonVariant& value);
4749
4850/* *
49- * Writes the data in value to the node located at pathEquivilent to the
51+ * Writes the data in value to the node located at pathequivalent to the
5052 * REST API's PUT.
5153 * You should check success() after calling.
5254 * \param path The path inside of your db to the node you wish to update.
@@ -58,16 +60,16 @@ class FirebaseArduino {
5860/* *
5961 * Gets the value located at path.
6062 * You should check success() after calling.
61- * \param path The pathinside of your db of the node you wish to retrieve.
63+ * \param path The pathto the node you wish to retrieve.
6264 * \return The data located at that path. This may either be a single element
6365 * or it may be a json structure. Will only be populated if success() is true.
6466*/
6567 FirebaseObjectget (const char * path);
6668
6769/* *
68- * Remove thevariable , and possibly entire tree, located at path.
70+ * Remove thenode , and possibly entire tree, located at path.
6971 * You should check success() after calling.
70- * \param path The pathinside of your db to the node you wish to remove,
72+ * \param path The path to the node you wish to remove,
7173 * including all of its children.
7274*/
7375void remove (const char * path);