nn::boss::TaskActionBase Class

Syntax

class TaskActionBase

Description

Base class for task actions. There is no reason for an application to directly generate an instance of this class.

Member Functions

protected TaskActionBase Constructor.
protected V ~TaskActionBase Destructor.
protected SetHttpProperty 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.
Identifier: Description
ACTION_URL: The target URL. It has a data type of char[MAX_URL_LENGTH].
ACTION_HTTP_HEADER: A structure for URL option request headers. It has a data type of struct httpRequestHeader[MAX_HTTP_HEADER].
ACTION_CLIENT_CERT: The internal client certificate for HTTPS communication. It has a data type of nn::http::InternalClientCertId[MAX_CLIENT_CERT].
ACTION_CLIENT_CERT_NUM: The number of internal client certificates that have been set. Data type is u32.
ACTION_ROOT_CA: The internal root certificate for HTTPS communication. It has a data type of nn::http::InternalCaCertId.
ACTION_ROOT_CA_NUM: The number of internal root certificates to specify. Data type is u32.
ACTION_PRIVATE_CLIENT_CERT: Flag for enabling a private client certificate. It has a data type of u8.
ACTION_PRIVATE_ROOT_CA: Flag for enabling a private root certificate. It has a data type of u8.
ACTION_AP_INFO: Type of access point information for attaching AP information to an HTTP query. It has a data type of ApInfoType.
ACTION_LAST_MODIFIED_TIME: The "Last-Modified" date and time to set in the HTTP request header. Data type is char[MAX_LASTMODIFIED_LENGTH].
protected GetHttpProperty 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.
Identifier: Description
ACTION_URL: The target URL. It has a data type of char[MAX_URL_LENGTH].
ACTION_HTTP_HEADER: A structure for URL option request headers. It has a data type of struct httpRequestHeader[MAX_HTTP_HEADER].
ACTION_CLIENT_CERT: The internal client certificate for HTTPS communication. It has a data type of nn::http::InternalClientCertId[MAX_CLIENT_CERT].
ACTION_CLIENT_CERT_NUM: The number of internal client certificates that have been set. Data type is u32.
ACTION_ROOT_CA: The internal root certificate for HTTPS communication. It has a data type of nn::http::InternalCaCertId.
ACTION_ROOT_CA_NUM: The number of internal root certificates to specify. Data type is u32.
ACTION_PRIVATE_CLIENT_CERT: Flag for enabling a private client certificate. It has a data type of u8.
ACTION_PRIVATE_ROOT_CA: Flag for enabling a private root certificate. It has a data type of u8.
ACTION_AP_INFO: Type of access point information for attaching AP information to an HTTP query. It has a data type of ApInfoType.
protected SetFileProperty 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.
Identifier: Description
ACTION_OFFSET: The offset from the starting position of the data specified by the URL. Data type is u32.
ACTION_FILEPATH: Local path to the file being downloaded. The data type is char[MAX_FILEPATH_LENGTH].
ACTION_FILEPATH_W: Local path to the file being downloaded. The data type is wchar_t[MAX_FILEPATH_LENGTH].
ACTION_FILE_HANDLE: File handle to the file being downloaded. The data type is nnHandle.
protected GetFileProperty 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.
Identifier: Description
ACTION_OFFSET: The offset from the starting position of the data specified by the URL. Data type is u32.
ACTION_FILEPATH: Local path to the file being downloaded. The data type is char[MAX_FILEPATH_LENGTH].
ACTION_FILEPATH_W: Local path to the file being downloaded. The data type is wchar_t[MAX_FILEPATH_LENGTH].
ACTION_FILE_HANDLE: File handle to the file being downloaded. The data type is nnHandle.
SetPrivateRootCa Sets a registered private root certificate for use. It can be used alongside an internal root certificate.
SetRootCa Sets an internal root certificate for use. It can be used alongside a private root certificate.
SetPrivateClientCert Sets a registered private client certificate for use. Only a private root certificate can be used.
SetClientCert Sets an internal client certificate for use. Only the one specified internal client certificate can be used.
SetApInfo Adds access point information.
AddHeaderField Adds header fields to the HTTP header.
SetLastModifiedTime Sets the initial value for the LastModifiedTime.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL