Cookie commands for the webdriver protocol

chrome/test/webdriver/commands/command.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_TEST_WEBDRIVER_COMMANDS_COMMAND_H_
 #define CHROME_TEST_WEBDRIVER_COMMANDS_COMMAND_H_
 
 #include <string>
 #include <vector>
 
@@ skipping 36 matching lines @@
 
  protected:
 
   // Returns the path variable encoded at the |i|th index (0-based) in the
   // request URL for this command. If the index is out of bounds, an empty
   // string will be returned.
   inline std::string GetPathVariable(const size_t i) const {
     return i < path_segments_.size() ? path_segments_.at(i) : "";
   }
 
-  // Returns the command parameter with the given |key| as a UTF-16 string.
+  // Provides the command parameter with the given |key| as a UTF-16 string.
   // Returns true on success.
   bool GetStringParameter(const std::string& key, string16* out) const;
 
-  // Returns the command parameter with the given |key| as a UTF-8 string.
+  // Provides the command parameter with the given |key| as a UTF-8 string.
   // Returns true on success.
   bool GetStringParameter(const std::string& key, std::string* out) const;
 
-  // Returns the command parameter with the given |key| as a ASCII string.
+  // Provides the command parameter with the given |key| as a ASCII string.
   // Returns true on success.
   bool GetStringASCIIParameter(const std::string& key, std::string* out) const;
 
-  // Returns the command parameter with the given |key| as a boolean. Returns
+  // Provides the command parameter with the given |key| as a boolean. Returns
   // false if there is no such parameter, or if it is not a boolean.
   bool GetBooleanParameter(const std::string& key, bool* out) const;
 
-  // Returns the command parameter with the given |key| as a int. Returns
+  // Provides the command parameter with the given |key| as a int. Returns
   // false if there is no such parameter, or if it is not a int.
   bool GetIntegerParameter(const std::string& key, int* out) const;
 
-  // Returns the command parameter with the given |key| as a list. Returns
+  // Provides the command parameter with the given |key| as a Dictionary.
+  // Returns false if there is no such parameter, or if it is not a Dictionary.
+  bool GetDictionaryParameter(const std::string& key,
+                              DictionaryValue** out) const;
+
+  // Provides the command parameter with the given |key| as a list. Returns
   // false if there is no such parameter, or if it is not a list.
   bool GetListParameter(const std::string& key, ListValue** out) const;
 
  private:
   const std::vector<std::string> path_segments_;
   const scoped_ptr<const DictionaryValue> parameters_;
 
   // An autorelease pool must exist on any thread where Objective C is used,
   // even implicitly. Otherwise the warning:
   //   "Objects autoreleased with no pool in place."
   // is printed for every object deallocted.  Since every incomming command to
   // chrome driver is allocated a new thread, the release pool is declared here.
   base::mac::ScopedNSAutoreleasePool autorelease_pool;
 
   DISALLOW_COPY_AND_ASSIGN(Command);
 };
 
 }  // namespace webdriver
 
 #endif  // CHROME_TEST_WEBDRIVER_COMMANDS_COMMAND_H_