1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::boss::TaskActionBase</title> 51 </head> 52 <body> 53<h1><CODE>nn::boss::TaskActionBase</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class TaskActionBase</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Base class for task actions. There is no reason for an application to directly generate an instance of this class.</p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> 67<span class="protected_style" title="protected">protected</span> </td> 68 <th> 69<a href="../../../nn/boss/TaskActionBase/TaskActionBase.html"><CODE>TaskActionBase</CODE></a> 70 </th> 71<td>Constructor.</td> 72 </tr> 73 <tr> 74 <td width="100"> 75<span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 76 </td> 77 <th> 78<a href="../../../nn/boss/TaskActionBase/~TaskActionBase.html"><CODE>~TaskActionBase</CODE></a> 79 </th> 80<td>Destructor.</td> 81 </tr> 82 <tr> 83 <td width="100"> 84<span class="protected_style" title="protected">protected</span> </td> 85 <th> 86<a href="../../../nn/boss/TaskActionBase/SetHttpProperty.html"><CODE>SetHttpProperty</CODE></a> 87 </th> 88<td>Sets a property value in the class. Call this function after allocating memory for the description's data type. It can be used for the following properties.<br /> <B>Identifier</B>: <B>Description</B><br /><CODE>ACTION_URL</CODE>: The target URL. It has a data type of <CODE>char[MAX_URL_LENGTH]</CODE>.<br /> <CODE>ACTION_HTTP_HEADER</CODE>: A structure for URL option request headers. It has a data type of <CODE>struct httpRequestHeader[MAX_HTTP_HEADER]</CODE>.<br /> <CODE>ACTION_CLIENT_CERT</CODE>: The internal client certificate for HTTPS communication. It has a data type of <CODE>nn::http::InternalClientCertId[MAX_CLIENT_CERT]</CODE>.<br /> <CODE>ACTION_CLIENT_CERT_NUM</CODE>: The number of internal client certificates that have been set. Data type is <CODE>u32</CODE>.<br /> <CODE>ACTION_ROOT_CA</CODE>: The internal root certificate for HTTPS communication. It has a data type of <CODE>nn::http::InternalCaCertId</CODE>.<br /> <CODE>ACTION_ROOT_CA_NUM</CODE>: The number of internal root certificates to specify. Data type is <CODE>u32</CODE>.<br /> <CODE>ACTION_PRIVATE_CLIENT_CERT</CODE>: Flag for enabling a private client certificate. It has a data type of <CODE>u8</CODE>.<br /> <CODE>ACTION_PRIVATE_ROOT_CA</CODE>: Flag for enabling a private root certificate. It has a data type of <CODE>u8</CODE>.<br /> <CODE>ACTION_AP_INFO</CODE>: Type of access point information for attaching AP information to an HTTP query. It has a data type of <CODE>ApInfoType</CODE>.<br /> <CODE>ACTION_LAST_MODIFIED_TIME</CODE>: The "<CODE>Last-Modified</CODE>" date and time to set in the HTTP request header. Data type is <CODE>char[MAX_LASTMODIFIED_LENGTH]</CODE>. <br /></td> 89 </tr> 90 <tr> 91 <td width="100"> 92<span class="protected_style" title="protected">protected</span> </td> 93 <th> 94<a href="../../../nn/boss/TaskActionBase/GetHttpProperty.html"><CODE>GetHttpProperty</CODE></a> 95 </th> 96<td>Gets a property value from the class. Call this function after allocating memory for the description's data type. It can be used for the following properties.<br /> <B>Identifier</B>: <B>Description</B><br /><CODE>ACTION_URL</CODE>: The target URL. It has a data type of <CODE>char[MAX_URL_LENGTH]</CODE>.<br /> <CODE>ACTION_HTTP_HEADER</CODE>: A structure for URL option request headers. It has a data type of <CODE>struct httpRequestHeader[MAX_HTTP_HEADER]</CODE>.<br /> <CODE>ACTION_CLIENT_CERT</CODE>: The internal client certificate for HTTPS communication. It has a data type of <CODE>nn::http::InternalClientCertId[MAX_CLIENT_CERT]</CODE>.<br /> <CODE>ACTION_CLIENT_CERT_NUM</CODE>: The number of internal client certificates that have been set. Data type is <CODE>u32</CODE>.<br /> <CODE>ACTION_ROOT_CA</CODE>: The internal root certificate for HTTPS communication. It has a data type of <CODE>nn::http::InternalCaCertId</CODE>.<br /> <CODE>ACTION_ROOT_CA_NUM</CODE>: The number of internal root certificates to specify. Data type is <CODE>u32</CODE>.<br /> <CODE>ACTION_PRIVATE_CLIENT_CERT</CODE>: Flag for enabling a private client certificate. It has a data type of <CODE>u8</CODE>.<br /> <CODE>ACTION_PRIVATE_ROOT_CA</CODE>: Flag for enabling a private root certificate. It has a data type of <CODE>u8</CODE>.<br /> <CODE>ACTION_AP_INFO</CODE>: Type of access point information for attaching AP information to an HTTP query. It has a data type of <CODE>ApInfoType</CODE>. <br /></td> 97 </tr> 98 <tr> 99 <td width="100"> 100<span class="protected_style" title="protected">protected</span> </td> 101 <th> 102<a href="../../../nn/boss/TaskActionBase/SetFileProperty.html"><CODE>SetFileProperty</CODE></a> 103 </th> 104<td>Gets a property value from the class. Call this function after allocating memory for the description's data type. It can be used for the following properties.<br /> <B>Identifier</B>: <B>Description</B><br /><CODE>ACTION_OFFSET</CODE>: The offset from the starting position of the data specified by the URL. Data type is <CODE>u32</CODE>.<br /> <CODE>ACTION_FILEPATH</CODE>: Local path to the file being downloaded. The data type is <CODE>char[MAX_FILEPATH_LENGTH]</CODE>.<br /> <CODE>ACTION_FILEPATH_W</CODE>: Local path to the file being downloaded. The data type is <CODE>wchar_t[MAX_FILEPATH_LENGTH]</CODE>.<br /> <CODE>ACTION_FILE_HANDLE</CODE>: File handle to the file being downloaded. The data type is <CODE>nnHandle</CODE>. <br /></td> 105 </tr> 106 <tr> 107 <td width="100"> 108<span class="protected_style" title="protected">protected</span> </td> 109 <th> 110<a href="../../../nn/boss/TaskActionBase/GetFileProperty.html"><CODE>GetFileProperty</CODE></a> 111 </th> 112<td>Gets a property value from the class. Call this function after allocating memory for the description's data type. It can be used for the following properties.<br /> <B>Identifier</B>: <B>Description</B><br /><CODE>ACTION_OFFSET</CODE>: The offset from the starting position of the data specified by the URL. Data type is <CODE>u32</CODE>.<br /> <CODE>ACTION_FILEPATH</CODE>: Local path to the file being downloaded. The data type is <CODE>char[MAX_FILEPATH_LENGTH]</CODE>.<br /> <CODE>ACTION_FILEPATH_W</CODE>: Local path to the file being downloaded. The data type is <CODE>wchar_t[MAX_FILEPATH_LENGTH]</CODE>.<br /> <CODE>ACTION_FILE_HANDLE</CODE>: File handle to the file being downloaded. The data type is <CODE>nnHandle</CODE>. <br /></td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117<a href="../../../nn/boss/TaskActionBase/SetPrivateRootCa.html"><CODE>SetPrivateRootCa</CODE></a> 118 </th> 119<td>Sets a registered private root certificate for use. It can be used alongside an internal root certificate.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124<a href="../../../nn/boss/TaskActionBase/SetRootCa.html"><CODE>SetRootCa</CODE></a> 125 </th> 126<td>Sets an internal root certificate for use. It can be used alongside a private root certificate.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131<a href="../../../nn/boss/TaskActionBase/SetPrivateClientCert.html"><CODE>SetPrivateClientCert</CODE></a> 132 </th> 133<td>Sets a registered private client certificate for use. Only a private root certificate can be used.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138<a href="../../../nn/boss/TaskActionBase/SetClientCert.html"><CODE>SetClientCert</CODE></a> 139 </th> 140<td>Sets an internal client certificate for use. Only the one specified internal client certificate can be used.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145<a href="../../../nn/boss/TaskActionBase/SetApInfo.html"><CODE>SetApInfo</CODE></a> 146 </th> 147<td>Adds access point information.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152<a href="../../../nn/boss/TaskActionBase/AddHeaderField.html"><CODE>AddHeaderField</CODE></a> 153 </th> 154<td>Adds header fields to the HTTP header.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<a href="../../../nn/boss/TaskActionBase/SetLastModifiedTime.html"><CODE>SetLastModifiedTime</CODE></a> 160 </th> 161<td>Sets the initial value for the <CODE>LastModifiedTime</CODE>.</td> 162 </tr> </table> 163 </div> 164 </a> 165<h2>Revision History</h2> 166 <div class="section"> 167 <dl class="history"> 168 <dt>2010/09/16</dt> 169<dd>Initial version.<br /> 170 </dd> 171 </dl> 172 </div> 173 <hr><p>CONFIDENTIAL</p></body> 174</html>