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::DataStoreDownloadAction</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::DataStoreDownloadAction</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class DataStoreDownloadAction : public <a href="../../../nn/boss/TaskAction/Overview.html">nn::boss::TaskAction</a></pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class for representing <CODE>DataStore</CODE> download tasks. Use this to do such things as register <CODE>DataStore</CODE> download tasks.</p><p><I>DataStore</I> is one of the NEX library data storage features. It can upload data to and download data from storage, and it also allows users to exchange data. (For more details, see the documentation in the NEX library.))<br /> BOSS DataStore tasks are provided for using these DataStore features via BOSS (SpotPass).<br /> You can use BOSS DataStore tasks for DataStore uploads and downloads even when your application is not running (when the system is in Sleep Mode, for example).<br /></p><p>A DataStore download task records information for the data it has downloaded so that the next time it is run, it will only download updated data (data that has not been downloaded before). The downloaded data is saved in BOSS storage in the NSD format. As a result, to read data use functions (such as <a href="../../../nn/boss/NsData/Overview.html"><CODE>nn::boss::NsData</CODE></a>) that are similar to the (NSD) data downloaded by the NADL task. Just as for data downloaded by an NADL task, old data (with earlier serial IDs) is deleted automatically when BOSS storage is full. After being configured by the <a href="../../../nn/boss/DataStoreDownloadAction/SetNewsPublication.html"><CODE>SetNewsPublication</CODE></a> function, a notification is issued when updated data is downloaded.</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"> </td> 67 <th> 68<a href="../../../nn/boss/DataStoreDownloadAction/DataStoreDownloadAction.html"><CODE>DataStoreDownloadAction</CODE></a> 69 </th> 70<td>Constructor.</td> 71 </tr> 72 <tr> 73<td width="100"> <span class="virtual_style" title="virtual">V</span> 74 </td> 75 <th> 76<a href="../../../nn/boss/DataStoreDownloadAction/~DataStoreDownloadAction.html"><CODE>~DataStoreDownloadAction</CODE></a> 77 </th> 78<td>Destructor.</td> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83<a href="../../../nn/boss/DataStoreDownloadAction/Initialize.html"><CODE>Initialize</CODE></a> 84 </th> 85<td>Configures <CODE>DataStore</CODE> download tasks.</td> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90<a href="../../../nn/boss/DataStoreDownloadAction/SetNewsPublication.html"><CODE>SetNewsPublication</CODE></a> 91 </th> 92<td>Configures how a notification is issued.<br /><br />The notification to be issued must have a subject and text that comply with Nintendo's guidelines.<br />Use the serial IDs issued by Nintendo for these types of notifications when you specify values for this function's <SPAN class="argument">serialId</SPAN> parameter.<br /> Apply for DataStore notifications on OMAS.<br /><br />The <SPAN class="argument">jumpParam</SPAN> parameter can be used starting at SDK 4.1.0 or later. If the value will be used in the destination application, put it in an 8-byte array.<br />The specified value can be obtained with <CODE><a href="../../../nn/news/CTR/user/IsFromNewsList.html">nn::news::CTR::user::IsFromNewsList</a></CODE> in the destination application.<br />If the value will not be used in the destination application, the specified value is meaningless and can be set to any number (for example, an 8-byte array filled with 0s).<br /></td> 93 </tr> 94 <tr> 95 <td width="100"> </td> 96 <th> 97<a href="../../../nn/boss/DataStoreDownloadAction/ClearNewsPublication.html"><CODE>ClearNewsPublication</CODE></a> 98 </th> 99<td>Clears all settings used when issuing notification data.</td> 100 </tr> 101 <tr> 102<td width="100"> <span class="virtual_style" title="virtual">V</span> 103 </td> 104 <th> 105<a href="../../../nn/boss/DataStoreDownloadAction/GetProperty.html"><CODE>GetProperty</CODE></a> 106 </th> 107<td>Gets a property value from the class.</td> 108 </tr> </table> 109 </div> 110 </a> 111<h2>Class Hierarchy</h2> 112 <div class="section"> 113<p class="hierarchy"><a href="../../../nn/boss/TaskActionBase/Overview.html"><CODE>nn::boss::TaskActionBase</CODE></a><br /> <a href="../../../nn/boss/TaskAction/Overview.html"><CODE>nn::boss::TaskAction</CODE></a><br /> <b><CODE>nn::boss::DataStoreDownloadAction</CODE></b> 114 </p> 115 </div> 116<h2>Revision History</h2> 117 <div class="section"> 118 <dl class="history"> 119 <dt>2011/10/27</dt> 120<dd>Initial version.<br /> 121 </dd> 122 </dl> 123 </div> 124 <hr><p>CONFIDENTIAL</p></body> 125</html>