Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
Represents the parameters when downloading comment data. More...
#include <CTR_SDK/include/nn/olv/olv_TypesDownloadCommentData.h>
Public Types | |
enum | { FLAG_NONE = 0, FLAG_FILTER_BY_FRIEND = (1<<0), FLAG_FILTER_BY_FOLLOW = (1<<1), FLAG_FILTER_BY_SELF = (1<<2), FLAG_FILTER_BY_BODY_TEXT = (1<<3), FLAG_FILTER_BY_BODY_MEMO = (1<<4), FLAG_DISTINCT_PID = (1<<5), FLAG_WITH_MII_DATA = (1<<6), FLAG_WITH_SPOILER = (1<<8) } |
Flags that can be specified in the SetFlags function. More... | |
Public Member Functions | |
DownloadCommentDataListParam () | |
Instantiates the object. | |
u32 | GetWorkSize () const |
Gets the size of the working buffer used by the nn::olv::DownloadCommentDataList function. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
void | SetBodyTextMaxLength (u32 bodyTextMaxLength) |
Sets the maximum length of text data. More... | |
void | SetCommentDataMaxNum (u32 commentDataMaxNum) |
Sets the maximum number of comments to download. More... | |
void | SetCommentId (const char *commentId) |
Sets the comment ID. More... | |
void | SetFlags (u32 flags) |
Sets flags. More... | |
void | SetLanguageId (u8 languageId) |
Sets the language ID. More... | |
void | SetPostDate (const nn::fnd::DateTime postDate) |
Sets the date the comment was made. More... | |
void | SetPostId (const char *postId) |
Sets the post ID for the comment data to download. More... | |
void | SetWork (u8 *work, u32 workSize) |
Sets the size of the working buffer used by the nn::olv::DownloadCommentDataList function. More... | |
Represents the parameters when downloading comment data.
anonymous enum |
Flags that can be specified in the SetFlags
function.
FLAG_FILTER_BY_BODY_TEXT
or FLAG_FILTER_BY_BODY_MEMO
to filter the comments to download.FLAG_FILTER_BY_SELF
, FLAG_FILTER_BY_FRIEND
, and FLAG_FILTER_BY_FOLLOW
are ignored if specified. (Support is planned for future versions.)FLAG_WITH_SPOILER
to download comments that include spoilers.SetCommentId
function, the only flag that can be specified is FLAG_WITH_MII_DATA
. u32 GetWorkSize | ( | ) | const |
Gets the size of the working buffer used by the nn::olv::DownloadCommentDataList
function.
Call this function after all of the various parameters have been specified, with the exception of the SetWork
function.
This function returns fixed values.
nn::olv::DownloadCommentDataList
function. void SetBodyTextMaxLength | ( | u32 | bodyTextMaxLength | ) |
Sets the maximum length of text data.
Specifying this option is not required. If not specified, the maximum length defaults to 100 characters.
Text data that exceeds the maximum character length is truncated at the maximum number of characters and downloaded.
[in] | bodyTextMaxLength | The maximum character length for text data. The range of values that can be specified is from 1 to nn::olv::BODY_TEXT_MAX_LENGTH . |
void SetCommentDataMaxNum | ( | u32 | commentDataMaxNum | ) |
Sets the maximum number of comments to download.
You must specify this option.
[in] | commentDataMaxNum | The maximum number of comments to download. Make sure that you specify a value equal to or greater than this maximum value for the number of arrays in the commentDataList argument to the nn::olv::DownloadCommentDataList function. |
void SetCommentId | ( | const char * | commentId | ) |
Sets the comment ID.
Specifying this option is not required.
If you specify a comment ID, only the comment with the set ID is downloaded.
[in] | commentId | The comment ID. |
void SetFlags | ( | u32 | flags | ) |
Sets flags.
Specifying this option is not required.
[in] | flags | Flags (FLAG_* ). |
void SetLanguageId | ( | u8 | languageId | ) |
Sets the language ID.
Specifying this option is not required. If no language ID is set, comments in the language set in System Settings are downloaded.
See nn::cfg::CfgLanguageCode
for the language IDs.
Specify nn::olv::LANGUAGE_ID_ALL
to download comments in all languages.
[in] | languageId | The language ID. |
void SetPostDate | ( | const nn::fnd::DateTime | postDate | ) |
Sets the date the comment was made.
Specifying this option is not required.
If you specify a date, only comments that were made on the specified date are downloaded.
Set a date that adjusts for the difference from the time zone of the account.
[in] | postDate | The date the comment was made. |
void SetPostId | ( | const char * | postId | ) |
Sets the post ID for the comment data to download.
You must specify this option.
[in] | postId | The post ID. |
void SetWork | ( | u8 * | work, |
u32 | workSize | ||
) |
Sets the size of the working buffer used by the nn::olv::DownloadCommentDataList
function.
You must specify this option.
Specify a buffer of at least the size obtained with the GetWorkSize
function.
[in] | work | The working buffer. |
[in] | workSize | The size of the working buffer. |