2525#endif // FIREBASE_JSONBUFFER_SIZE
2626
2727/* *
28- *Gateway class for Arduino clients to interact withthe Firebase backend .
28+ *Main class for Arduino clients to interact with Firebase.
2929 * This implementation is designed to follow Arduino best practices and favor
3030 * simplicity over all else.
3131 * For more complicated usecases and more control see the Firebase class in
3434class FirebaseArduino {
3535public:
3636/* *
37- * Must be called first. This sets the class up for use.
38- * \param host Your firebase db domain name, usually X.firebaseIO.com.
39- * \param auth Optional authentication for the db, a secret or token.
37+ * Must be called first. This initialize the client with the given
38+ * firebase host and credentials.
39+ * \param host Your firebase db host, usually X.firebaseio.com.
40+ * \param auth Optional credentials for the db, a secret or token.
4041*/
4142void begin (const char * host,const char * auth =" "
4243
4344/* *
44- *Adds the datain value to the list located at path.Equivilent to the
45- * REST API's POST.
45+ *Writes datato a new child location under the parent at path.
46+ *Equivalent to the REST API's POST.
4647 * You should check success() after calling.
47- * \param path The path inside of your db to thelist you wish to update .
48- * \param value Data that you wish to addto thelist .
49- * \return The childname where the data was written.
48+ * \param path The path inside of your db to theparent object .
49+ * \param value Data that you wish to addunder theparent .
50+ * \return Theunique childkey where the data was written.
5051*/
5152 Stringpush (const String& path,const JsonVariant& value);
5253
5354/* *
54- * Writes the data in value to the node located at pathEquivilent to the
55+ * Writes the data in value to the node located at pathequivalent to the
5556 * REST API's PUT.
5657 * You should check success() after calling.
5758 * \param path The path inside of your db to the node you wish to update.
@@ -63,16 +64,16 @@ class FirebaseArduino {
6364/* *
6465 * Gets the value located at path.
6566 * You should check success() after calling.
66- * \param path The pathinside of your db of the node you wish to retrieve.
67+ * \param path The pathto the node you wish to retrieve.
6768 * \return The data located at that path. This may either be a single element
6869 * or it may be a json structure. Will only be populated if success() is true.
6970*/
7071 FirebaseObjectget (const char * path);
7172
7273/* *
73- * Remove thevariable , and possibly entire tree, located at path.
74+ * Remove thenode , and possibly entire tree, located at path.
7475 * You should check success() after calling.
75- * \param path The pathinside of your db to the node you wish to remove,
76+ * \param path The path to the node you wish to remove,
7677 * including all of its children.
7778*/
7879void remove (const char * path);