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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorRequest</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorRequest</h1>

<p>
Module implementing a synchronous network request handler for translation
requests.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#TranslatorRequest">TranslatorRequest</a></td>
<td>Class implementing a synchronous network request handler for translation requests.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="TranslatorRequest" ID="TranslatorRequest"></a>
<h2>TranslatorRequest</h2>

<p>
    Class implementing a synchronous network request handler for translation
    requests.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#TranslatorRequest.__init__">TranslatorRequest</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#TranslatorRequest.get">get</a></td>
<td>Public method to issue a GET request.</td>
</tr>
<tr>
<td><a href="#TranslatorRequest.post">post</a></td>
<td>Public method to issue a POST request.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="TranslatorRequest.__init__" ID="TranslatorRequest.__init__"></a>
<h4>TranslatorRequest (Constructor)</h4>
<b>TranslatorRequest</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<a NAME="TranslatorRequest.get" ID="TranslatorRequest.get"></a>
<h4>TranslatorRequest.get</h4>
<b>get</b>(<i>requestUrl, extraHeaders=None</i>)

<p>
        Public method to issue a GET request.
</p>
<dl>

<dt><i>requestUrl</i> (QUrl)</dt>
<dd>
URL of the request
</dd>
<dt><i>extraHeaders</i> (tuple of (bytes, bytes))</dt>
<dd>
list of tuples of additional headers giving
            header name and header value
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
server response or an error message and a success flag
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (QByteArray or str, bool)
</dd>
</dl>
<a NAME="TranslatorRequest.post" ID="TranslatorRequest.post"></a>
<h4>TranslatorRequest.post</h4>
<b>post</b>(<i>requestUrl, requestData, dataType="form", extraHeaders=None</i>)

<p>
        Public method to issue a POST request.
</p>
<dl>

<dt><i>requestUrl</i> (QUrl)</dt>
<dd>
URL of the request
</dd>
<dt><i>requestData</i> (QByteArray)</dt>
<dd>
data of the request
</dd>
<dt><i>dataType</i> (str)</dt>
<dd>
type of the request data
</dd>
<dt><i>extraHeaders</i> (list of tuple of (bytes, bytes))</dt>
<dd>
list of tuples of additional headers giving
            header name and header value
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple of server response (string) and flag indicating
            success (boolean)
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>