Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(451)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/extensions/webRequest.html

Issue 10694055: Add read-only access to POST data for webRequest's onBeforeRequest (Closed) Base URL: http://git.chromium.org/chromium/src.git@master
Patch Set: Dominic's comments + adjusting to the recent move of UploadElement out of UploadData. Created 8 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« chrome/browser/extensions/api/web_request/form_data_parser.cc ('K') | « chrome/common/extensions/api/web_request_internal.json ('k') | chrome/test/data/extensions/api_test/webrequest/framework.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 252 matching lines...) Expand 10 before | Expand all | Expand 10 after
263 <ol> 263 <ol>
264 </ol> 264 </ol>
265 </li><li> 265 </li><li>
266 <a href="#type-webRequest.HttpHeaders">HttpHeaders</a> 266 <a href="#type-webRequest.HttpHeaders">HttpHeaders</a>
267 <ol> 267 <ol>
268 </ol> 268 </ol>
269 </li><li> 269 </li><li>
270 <a href="#type-webRequest.BlockingResponse">BlockingResponse</a> 270 <a href="#type-webRequest.BlockingResponse">BlockingResponse</a>
271 <ol> 271 <ol>
272 </ol> 272 </ol>
273 </li><li>
274 <a href="#type-webRequest.UploadData">UploadData</a>
275 <ol>
276 </ol>
273 </li> 277 </li>
274 </ol> 278 </ol>
275 </li> 279 </li>
276 </ol> 280 </ol>
277 </li> 281 </li>
278 </ol> 282 </ol>
279 </div> 283 </div>
280 <!-- /TABLE OF CONTENTS --> 284 <!-- /TABLE OF CONTENTS -->
281 <!-- Standard content lead-in for experimental API pages --> 285 <!-- Standard content lead-in for experimental API pages -->
282 <!-- STATIC CONTENT PLACEHOLDER --> 286 <!-- STATIC CONTENT PLACEHOLDER -->
(...skipping 1474 matching lines...) Expand 10 before | Expand all | Expand 10 after
1757 </dt> 1761 </dt>
1758 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd> 1762 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
1759 <!-- OBJECT PROPERTIES --> 1763 <!-- OBJECT PROPERTIES -->
1760 <!-- OBJECT METHODS --> 1764 <!-- OBJECT METHODS -->
1761 <!-- OBJECT EVENT FIELDS --> 1765 <!-- OBJECT EVENT FIELDS -->
1762 <!-- FUNCTION PARAMETERS --> 1766 <!-- FUNCTION PARAMETERS -->
1763 </div> 1767 </div>
1764 </div><div> 1768 </div><div>
1765 <div> 1769 <div>
1766 <dt> 1770 <dt>
1771 <var>requestBody</var>
1772 <em>
1773 <!-- TYPE -->
1774 <div style="display:inline">
1775 (
1776 <span class="optional">optional</span>
1777 <span id="typeTemplate">
1778 <span>
1779 <span>object</span>
1780 </span>
1781 </span>
1782 )
1783 </div>
1784 </em>
1785 </dt>
1786 <dd>Experimental feature, only available in DEV or CANARY channels. Co ntainer for request body data. Only provided if extraInfoSpec contains 'requestB ody'. Currently only request body elements containing byte data or files are rep orted. Presence of chunked elements results in an error.</dd>
1787 <!-- OBJECT PROPERTIES -->
1788 <dd>
1789 <dl>
1790 <div>
1791 <div>
1792 <dt>
1793 <var>error</var>
1794 <em>
1795 <!-- TYPE -->
1796 <div style="display:inline">
1797 (
1798 <span class="optional">optional</span>
1799 <span id="typeTemplate">
1800 <span>
1801 <span>string</span>
1802 </span>
1803 </span>
1804 )
1805 </div>
1806 </em>
1807 </dt>
1808 <dd>Errors when obtaining request body data.</dd>
1809 <!-- OBJECT PROPERTIES -->
1810 <!-- OBJECT METHODS -->
1811 <!-- OBJECT EVENT FIELDS -->
1812 <!-- FUNCTION PARAMETERS -->
1813 </div>
1814 </div><div>
1815 <div>
1816 <dt>
1817 <var>formData</var>
1818 <em>
1819 <!-- TYPE -->
1820 <div style="display:inline">
1821 (
1822 <span class="optional">optional</span>
1823 <span id="typeTemplate">
1824 <span>
1825 <span>object</span>
1826 </span>
1827 </span>
1828 )
1829 </div>
1830 </em>
1831 </dt>
1832 <dd>If the request method is POST and the body is a sequence of key-va lue pairs, encoded as either multipart/form-data, or application/x-www-form-urle ncoded, this dictionary is present and for each key contains the list of all val ues for that key. If the data is of another media type, or if it is malformed, t he dictionary is not present. It is also not present if the form upload is chunk ed. An example value of this dictionary is {'key': ['value1', 'value2']}.</dd>
1833 <!-- OBJECT PROPERTIES -->
1834 <dd>
1835 <dl>
1836 </dl>
1837 </dd>
1838 <!-- OBJECT METHODS -->
1839 <!-- OBJECT EVENT FIELDS -->
1840 <!-- FUNCTION PARAMETERS -->
1841 </div>
1842 </div><div>
1843 <div>
1844 <dt>
1845 <var>raw</var>
1846 <em>
1847 <!-- TYPE -->
1848 <div style="display:inline">
1849 (
1850 <span class="optional">optional</span>
1851 <span id="typeTemplate">
1852 <span>
1853 <span>
1854 array of <span><span>
1855 <span>
1856 <a href="webRequest.html#type-webRequest.UploadData">web Request.UploadData</a>
1857 </span>
1858 </span></span>
1859 </span>
1860 </span>
1861 </span>
1862 )
1863 </div>
1864 </em>
1865 </dt>
1866 <dd>If the request method is PUT or POST, and the body is not already parsed in formData, then the unparsed request body elements are contained in thi s array.</dd>
1867 <!-- OBJECT PROPERTIES -->
1868 <!-- OBJECT METHODS -->
1869 <!-- OBJECT EVENT FIELDS -->
1870 <!-- FUNCTION PARAMETERS -->
1871 </div>
1872 </div>
1873 </dl>
1874 </dd>
1875 <!-- OBJECT METHODS -->
1876 <!-- OBJECT EVENT FIELDS -->
1877 <!-- FUNCTION PARAMETERS -->
1878 </div>
1879 </div><div>
1880 <div>
1881 <dt>
1767 <var>tabId</var> 1882 <var>tabId</var>
1768 <em> 1883 <em>
1769 <!-- TYPE --> 1884 <!-- TYPE -->
1770 <div style="display:inline"> 1885 <div style="display:inline">
1771 ( 1886 (
1772 <span id="typeTemplate"> 1887 <span id="typeTemplate">
1773 <span> 1888 <span>
1774 <span>integer</span> 1889 <span>integer</span>
1775 </span> 1890 </span>
1776 </span> 1891 </span>
(...skipping 100 matching lines...) Expand 10 before | Expand all | Expand 10 after
1877 <!-- TYPE --> 1992 <!-- TYPE -->
1878 <div style="display:inline"> 1993 <div style="display:inline">
1879 ( 1994 (
1880 <span class="optional">optional</span> 1995 <span class="optional">optional</span>
1881 <span id="typeTemplate"> 1996 <span id="typeTemplate">
1882 <span> 1997 <span>
1883 <span> 1998 <span>
1884 array of <span><span> 1999 array of <span><span>
1885 <span> 2000 <span>
1886 <span>string</span> 2001 <span>string</span>
1887 <span>["blocking"]</span> 2002 <span>["blocking", "requestBody"]</span>
1888 </span> 2003 </span>
1889 </span></span> 2004 </span></span>
1890 </span> 2005 </span>
1891 </span> 2006 </span>
1892 </span> 2007 </span>
1893 ) 2008 )
1894 </div> 2009 </div>
1895 </em> 2010 </em>
1896 </dt> 2011 </dt>
1897 <dd>Array of extra information that should be passed to the listener f unction.</dd> 2012 <dd>Array of extra information that should be passed to the listener f unction.</dd>
(...skipping 2720 matching lines...) Expand 10 before | Expand all | Expand 10 after
4618 <!-- OBJECT EVENT FIELDS --> 4733 <!-- OBJECT EVENT FIELDS -->
4619 <!-- FUNCTION PARAMETERS --> 4734 <!-- FUNCTION PARAMETERS -->
4620 </div> 4735 </div>
4621 </div> 4736 </div>
4622 </dl> 4737 </dl>
4623 </dd> 4738 </dd>
4624 <!-- OBJECT METHODS --> 4739 <!-- OBJECT METHODS -->
4625 <!-- OBJECT EVENT FIELDS --> 4740 <!-- OBJECT EVENT FIELDS -->
4626 <!-- FUNCTION PARAMETERS --> 4741 <!-- FUNCTION PARAMETERS -->
4627 </div> 4742 </div>
4743 </div><div class="apiItem">
4744 <a name="type-webRequest.UploadData"></a>
4745 <h4>webRequest.UploadData</h4>
4746 <div>
4747 <dt>
4748 <em>
4749 <!-- TYPE -->
4750 <div style="display:inline">
4751 (
4752 <span id="typeTemplate">
4753 <span>
4754 <span>object</span>
4755 </span>
4756 </span>
4757 )
4758 </div>
4759 </em>
4760 </dt>
4761 <dd>Contains data uploaded in a URL request.</dd>
4762 <!-- OBJECT PROPERTIES -->
4763 <dd>
4764 <dl>
4765 <div>
4766 <div>
4767 <dt>
4768 <var>bytes</var>
4769 <em>
4770 <!-- TYPE -->
4771 <div style="display:inline">
4772 (
4773 <span class="optional">optional</span>
4774 <span id="typeTemplate">
4775 <span>
4776 <span>any</span>
4777 </span>
4778 </span>
4779 )
4780 </div>
4781 </em>
4782 </dt>
4783 <dd>An ArrayBuffer with a copy of the data.</dd>
4784 <!-- OBJECT PROPERTIES -->
4785 <!-- OBJECT METHODS -->
4786 <!-- OBJECT EVENT FIELDS -->
4787 <!-- FUNCTION PARAMETERS -->
4788 </div>
4789 </div><div>
4790 <div>
4791 <dt>
4792 <var>file</var>
4793 <em>
4794 <!-- TYPE -->
4795 <div style="display:inline">
4796 (
4797 <span class="optional">optional</span>
4798 <span id="typeTemplate">
4799 <span>
4800 <span>string</span>
4801 </span>
4802 </span>
4803 )
4804 </div>
4805 </em>
4806 </dt>
4807 <dd>A string with the file's path and name.</dd>
4808 <!-- OBJECT PROPERTIES -->
4809 <!-- OBJECT METHODS -->
4810 <!-- OBJECT EVENT FIELDS -->
4811 <!-- FUNCTION PARAMETERS -->
4812 </div>
4813 </div>
4814 </dl>
4815 </dd>
4816 <!-- OBJECT METHODS -->
4817 <!-- OBJECT EVENT FIELDS -->
4818 <!-- FUNCTION PARAMETERS -->
4819 </div>
4628 </div> <!-- /apiItem --> 4820 </div> <!-- /apiItem -->
4629 </div> <!-- /apiGroup --> 4821 </div> <!-- /apiGroup -->
4630 </div> <!-- /apiPage --> 4822 </div> <!-- /apiPage -->
4631 </div> <!-- /gc-pagecontent --> 4823 </div> <!-- /gc-pagecontent -->
4632 </div> <!-- /g-section --> 4824 </div> <!-- /g-section -->
4633 </div> <!-- /codesiteContent --> 4825 </div> <!-- /codesiteContent -->
4634 <div id="gc-footer" --=""> 4826 <div id="gc-footer" --="">
4635 <div class="text"> 4827 <div class="text">
4636 <p> 4828 <p>
4637 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 4829 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
(...skipping 29 matching lines...) Expand all
4667 _uff=0; 4859 _uff=0;
4668 urchinTracker(); 4860 urchinTracker();
4669 } 4861 }
4670 catch(e) {/* urchinTracker not available. */} 4862 catch(e) {/* urchinTracker not available. */}
4671 </script> 4863 </script>
4672 <!-- end analytics --> 4864 <!-- end analytics -->
4673 </div> 4865 </div>
4674 </div> <!-- /gc-footer --> 4866 </div> <!-- /gc-footer -->
4675 </div> <!-- /gc-container --> 4867 </div> <!-- /gc-container -->
4676 </body></html> 4868 </body></html>
OLDNEW
« chrome/browser/extensions/api/web_request/form_data_parser.cc ('K') | « chrome/common/extensions/api/web_request_internal.json ('k') | chrome/test/data/extensions/api_test/webrequest/framework.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698