src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorRequest.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9148
b31f0d894b55
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorRequest</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorRequest</h1>
10
11 <p>
12 Module implementing a synchronous network request handler for translation
13 requests.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#TranslatorRequest">TranslatorRequest</a></td>
26 <td>Class implementing a synchronous network request handler for translation requests.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="TranslatorRequest" ID="TranslatorRequest"></a>
37 <h2>TranslatorRequest</h2>
38
39 <p>
40 Class implementing a synchronous network request handler for translation
41 requests.
42 </p>
43 <h3>Derived from</h3>
44 QObject
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#TranslatorRequest.__init__">TranslatorRequest</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#TranslatorRequest.get">get</a></td>
65 <td>Public method to issue a GET request.</td>
66 </tr>
67 <tr>
68 <td><a href="#TranslatorRequest.post">post</a></td>
69 <td>Public method to issue a POST request.</td>
70 </tr>
71 </table>
72 <h3>Static Methods</h3>
73
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77
78 <a NAME="TranslatorRequest.__init__" ID="TranslatorRequest.__init__"></a>
79 <h4>TranslatorRequest (Constructor)</h4>
80 <b>TranslatorRequest</b>(<i>parent=None</i>)
81
82 <p>
83 Constructor
84 </p>
85 <dl>
86
87 <dt><i>parent</i> (QObject)</dt>
88 <dd>
89 reference to the parent object
90 </dd>
91 </dl>
92 <a NAME="TranslatorRequest.get" ID="TranslatorRequest.get"></a>
93 <h4>TranslatorRequest.get</h4>
94 <b>get</b>(<i>requestUrl, extraHeaders=None</i>)
95
96 <p>
97 Public method to issue a GET request.
98 </p>
99 <dl>
100
101 <dt><i>requestUrl</i> (QUrl)</dt>
102 <dd>
103 URL of the request
104 </dd>
105 <dt><i>extraHeaders</i> (tuple of (bytes, bytes))</dt>
106 <dd>
107 list of tuples of additional headers giving
108 header name and header value
109 </dd>
110 </dl>
111 <dl>
112 <dt>Return:</dt>
113 <dd>
114 server response or an error message and a success flag
115 </dd>
116 </dl>
117 <dl>
118 <dt>Return Type:</dt>
119 <dd>
120 tuple of (QByteArray or str, bool)
121 </dd>
122 </dl>
123 <a NAME="TranslatorRequest.post" ID="TranslatorRequest.post"></a>
124 <h4>TranslatorRequest.post</h4>
125 <b>post</b>(<i>requestUrl, requestData, dataType="form", extraHeaders=None</i>)
126
127 <p>
128 Public method to issue a POST request.
129 </p>
130 <dl>
131
132 <dt><i>requestUrl</i> (QUrl)</dt>
133 <dd>
134 URL of the request
135 </dd>
136 <dt><i>requestData</i> (QByteArray)</dt>
137 <dd>
138 data of the request
139 </dd>
140 <dt><i>dataType</i> (str)</dt>
141 <dd>
142 type of the request data
143 </dd>
144 <dt><i>extraHeaders</i> (list of tuple of (bytes, bytes))</dt>
145 <dd>
146 list of tuples of additional headers giving
147 header name and header value
148 </dd>
149 </dl>
150 <dl>
151 <dt>Return:</dt>
152 <dd>
153 tuple of server response (string) and flag indicating
154 success (boolean)
155 </dd>
156 </dl>
157 <dl>
158 <dt>Return Type:</dt>
159 <dd>
160 tuple of (str, bool)
161 </dd>
162 </dl>
163 <div align="right"><a href="#top">Up</a></div>
164 <hr />
165 </body></html>

eric ide

mercurial