nn::boss::DataStoreDownloadAction

nn::boss::DataStoreDownloadAction Class

Syntax

class DataStoreDownloadAction : public nn::boss::TaskAction

Description

Class for representing DataStore download tasks. Use this to do such things as register DataStore download tasks.

DataStore 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.))
BOSS DataStore tasks are provided for using these DataStore features via BOSS (SpotPass).
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).

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 nn::boss::NsData) 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 SetNewsPublication function, a notification is issued when updated data is downloaded.

Member Functions

DataStoreDownloadAction Constructor.
V ~DataStoreDownloadAction Destructor.
Initialize Configures DataStore download tasks.
SetNewsPublication Configures how a notification is issued.

The notification to be issued must have a subject and text that comply with Nintendo's guidelines.
Use the serial IDs issued by Nintendo for these types of notifications when you specify values for this function's serialId parameter.
Apply for DataStore notifications on OMAS.

The jumpParam 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.
The specified value can be obtained with nn::news::CTR::user::IsFromNewsList in the destination application.
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).
ClearNewsPublication Clears all settings used when issuing notification data.
V GetProperty Gets a property value from the class.

Class Hierarchy

nn::boss::TaskActionBase
  nn::boss::TaskAction
    nn::boss::DataStoreDownloadAction

Revision History

2011/10/27
Initial version.

CONFIDENTIAL