2020#include " Firebase.h"
2121#include " FirebaseObject.h"
2222
23- #ifndef FIREBASE_JSONBUFFER_SIZE
24- #define FIREBASE_JSONBUFFER_SIZE 200
25- #endif // FIREBASE_JSONBUFFER_SIZE
26-
2723/* *
28- *Gateway class for Arduino clients to interact withthe Firebase backend .
24+ *Main class for Arduino clients to interact with Firebase.
2925 * This implementation is designed to follow Arduino best practices and favor
30- * simplicity over all else. For more complicated usecases and more control
31- * 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.
3229*/
3330class FirebaseArduino {
3431public:
3532/* *
36- * Must be called first. This sets the class up for use.
37- * \param host Your firebase db server domain name, usually X.firebaseIO.com.
38- * \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.
3937*/
4038void begin (const char * host,const char * auth =" "
4139
4240/* *
43- *Adds the datain value to the list located at path.Equivilent to the
44- * REST API's POST.
41+ *Writes datato a new child location under the parent at path.
42+ *Equivalent to the REST API's POST.
4543 * You should check success() after calling.
46- * \param path The path inside of your db to thelist you wish to update .
47- * \param value Data that you wish to addto thelist .
48- * \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.
4947*/
5048 Stringpush (const String& path,const JsonVariant& value);
5149
5250/* *
53- * 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
5452 * REST API's PUT.
5553 * You should check success() after calling.
5654 * \param path The path inside of your db to the node you wish to update.
@@ -62,16 +60,16 @@ class FirebaseArduino {
6260/* *
6361 * Gets the value located at path.
6462 * You should check success() after calling.
65- * \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.
6664 * \return The data located at that path. This may either be a single element
6765 * or it may be a json structure. Will only be populated if success() is true.
6866*/
6967 FirebaseObjectget (const char * path);
7068
7169/* *
72- * Remove thevariable , and possibly entire tree, located at path.
70+ * Remove thenode , and possibly entire tree, located at path.
7371 * You should check success() after calling.
74- * \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,
7573 * including all of its children.
7674*/
7775void remove (const char * path);