Documentation

1 files changed, 69 insertions, 0 deletions

diff --git a/include/tgbot/net/HttpReqArg.h b/include/tgbot/net/HttpReqArg.h
new file mode 100644
index 0000000..d70e8b5
--- /dev/null
+++ b/include/tgbot/net/HttpReqArg.h
@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2015 Oleg Morozenkov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef TGBOT_HTTPPARAMETER_H
+#define TGBOT_HTTPPARAMETER_H
+
+#include <string>
+
+#include <boost/lexical_cast.hpp>
+
+namespace TgBot {
+
+/**
+ * This class represents argument in POST http requests.
+ * @ingroup net
+ */
+class HttpReqArg {
+
+public:
+    template<typename T>
+    HttpReqArg(const std::string& name, const T& value, bool isFile = false, const std::string& mimeType = "text/plain") :
+            name(name), value(boost::lexical_cast<std::string>(value)), isFile(isFile), mimeType(mimeType)
+    {
+    }
+
+    /**
+     * Name of an argument.
+     */
+    std::string name;
+
+    /**
+     * Value of an argument.
+     */
+    std::string value;
+
+    /**
+     * Should be true if an argument value hold some file contents
+     */
+    bool isFile = false;
+
+    /**
+     * Mime type of an argument value. This field makes sense only if isFile is true.
+     */
+    std::string mimeType = "text/plain";
+};
+
+}
+
+
+#endif //TGBOT_HTTPPARAMETER_H