Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
A class that stores the downloaded post data. More...
#include <CTR_SDK/include/nn/olv/olv_TypesDownloadPostData.h>
Public Types | |
enum | { FLAG_NONE = 0, FLAG_WITH_BODY_TEXT = DOWNLOAD_FLAG_VALUE_WITH_BODY_TEXT, FLAG_WITH_BODY_MEMO = DOWNLOAD_FLAG_VALUE_WITH_BODY_MEMO, FLAG_WITH_EXTERNAL_IMAGE_DATA = DOWNLOAD_FLAG_VALUE_WITH_EXTERNAL_IMAGE_DATA, FLAG_WITH_MII_DATA = DOWNLOAD_FLAG_VALUE_WITH_MII_DATA, FLAG_WITH_EXTERNAL_URL = DOWNLOAD_FLAG_VALUE_WITH_EXTERNAL_URL, FLAG_WITH_APP_DATA = DOWNLOAD_FLAG_VALUE_WITH_APP_DATA, FLAG_EMPATHY_ADDED = DOWNLOAD_FLAG_VALUE_EMPATHY_ADDED, FLAG_FREE_FORMAT = DOWNLOAD_FLAG_VALUE_FREE_FORMAT, FLAG_SPOILER = DOWNLOAD_FLAG_VALUE_SPOILER } |
Flags that can be specified in the TestFlags function. More... | |
Public Member Functions | |
DownloadedPostData () | |
Instantiates the object. | |
nn::olv::Result | DownloadExternalImageData (void *externalImageData, u32 *externalImageDataSize, u32 externalImageDataMaxSize) const |
Downloads the attached image data. More... | |
void | GetAppData (u8 *appData, u32 *appDataSize, u32 appDataMaxSize) const |
Gets application data. More... | |
u32 | GetAppDataSize () const |
Gets the size of the application data. More... | |
void | GetBodyMemo (u8 *bodyMemo, u32 *bodyMemoSize, u32 bodyMemoMaxSize) const |
Gets the handwritten memo data. More... | |
void | GetBodyText (wchar_t *bodyText, u32 bodyTextMaxLength) const |
Gets text data. More... | |
u32 | GetCommentCount () const |
Gets the number of comments. More... | |
u32 | GetCommunityId () const |
Gets the community ID. More... | |
u8 | GetCountryId () const |
Gets the country ID. More... | |
u32 | GetEmpathyCount () const |
Gets the Yeah count. More... | |
u32 | GetExternalImageDataSize () const |
Gets the size of the attached image data. More... | |
void | GetExternalUrl (char *externalUrl, u32 externalUrlMaxLength) const |
Gets the attached URL. More... | |
s8 | GetFeeling () const |
Gets the mood. More... | |
u8 | GetLanguageId () const |
Gets the language ID. More... | |
void | GetMiiData (nn::mii::StoreData *storeData) const |
Gets the Mii data of the user. More... | |
void | GetMiiNickname (wchar_t *miiNickname, u32 miiNicknameMaxLength) const |
Gets the nickname of the Mii character of the user. More... | |
u8 | GetPlatformId () const |
Gets the platform ID. More... | |
nn::fnd::DateTime | GetPostDate () const |
Gets the date the post was made. More... | |
void | GetPostId (char *postId, u32 postIdMaxLength) const |
Gets the post ID. More... | |
u32 | GetRegionId () const |
Gets the region ID. More... | |
void | GetTopicTag (wchar_t *topicTag, u32 topicTagMaxLength) const |
Gets topic tags. More... | |
u32 | GetUserPid () const |
Gets the principal ID of the user. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
bool | TestFlags (u32 flags) const |
Tests flags. More... | |
A class that stores the downloaded post data.
anonymous enum |
Flags that can be specified in the TestFlags
function.
nn::olv::Result DownloadExternalImageData | ( | void * | externalImageData, |
u32 * | externalImageDataSize, | ||
u32 | externalImageDataMaxSize | ||
) | const |
Downloads the attached image data.
This function can only be used when the return value from the TestFlags
function is true
when FLAG_WITH_EXTERNAL_IMAGE_DATA
is specified.
This function causes Internet communication, during which time processing is blocked.
While this function is being called, you can call the nn::olv::Cancel
function from another thread to cancel communication processes.
This function is thread safe. However, be careful not to call functions in the OLV library that are not thread safe from other threads while this function is being called.
[out] | externalImageData | The buffer that stores the attached image data. |
[out] | externalImageDataSize | The buffer that stores the size of the attached image data. |
[in] | externalImageDataMaxSize | The size of the buffer that stores the attached image data. |
void GetAppData | ( | u8 * | appData, |
u32 * | appDataSize, | ||
u32 | appDataMaxSize | ||
) | const |
Gets application data.
This function can only be used when the return value from the TestFlags
function is true
when FLAG_WITH_APP_DATA
is specified.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
TestFlags
function with FLAG_WITH_APP_DATA
specified yields a return value of false
.NULL
is specified for the appData argument.GetAppDataSize
function is specified for the appDataMaxSize argument.[out] | appData | The buffer that stores the application data. |
[out] | appDataSize | The buffer that stores the size of the application data. |
[in] | appDataMaxSize | The size of the buffer that stores the application data. Make sure that you specify a value of at least that returned by the GetAppDataSize function. |
u32 GetAppDataSize | ( | ) | const |
Gets the size of the application data.
void GetBodyMemo | ( | u8 * | bodyMemo, |
u32 * | bodyMemoSize, | ||
u32 | bodyMemoMaxSize | ||
) | const |
Gets the handwritten memo data.
This function can only be used when the TestFlags
function is set to FLAG_WITH_BODY_MEMO
and returns true
.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
TestFlags
function is set to FLAG_WITH_BODY_MEMO
and returns false
.NULL
.nn::olv::BODY_MEMO_BUFF_LENGTH
is specified for the bodyMemoMaxSize parameter.[out] | bodyMemo | The buffer that stores the handwritten memo data. |
[out] | bodyMemoSize | The buffer that stores the size of the handwritten memo data. |
[in] | bodyMemoMaxSize | The size of the buffer that stores the handwritten memo data. Make sure that you specify a size of at least nn::olv::BODY_MEMO_BUFF_LENGTH . |
void GetBodyText | ( | wchar_t * | bodyText, |
u32 | bodyTextMaxLength | ||
) | const |
Gets text data.
This function can only be used when the return value from the TestFlags
function is true
when FLAG_WITH_BODY_TEXT
is specified.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
TestFlags
function with FLAG_WITH_BODY_TEXT
specified yields a return value of false
.NULL
is specified for the bodyText argument.nn::olv::BODY_TEXT_BUFF_LENGTH
is specified for the bodyTextMaxLength argument.[out] | bodyText | The buffer that stores the text data. |
[in] | bodyTextMaxLength | The length of the buffer that stores the text data, including the terminating null character. Make sure that you specify a size of at least nn::olv::BODY_TEXT_BUFF_LENGTH . |
u32 GetCommentCount | ( | ) | const |
Gets the number of comments.
u32 GetCommunityId | ( | ) | const |
Gets the community ID.
u8 GetCountryId | ( | ) | const |
Gets the country ID.
See nn::cfg::CfgCountryCode
for the country IDs.
u32 GetEmpathyCount | ( | ) | const |
Gets the Yeah count.
u32 GetExternalImageDataSize | ( | ) | const |
Gets the size of the attached image data.
void GetExternalUrl | ( | char * | externalUrl, |
u32 | externalUrlMaxLength | ||
) | const |
Gets the attached URL.
This function can only be used when the return value from the TestFlags
function is true
when FLAG_WITH_EXTERNAL_URL
is specified.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
TestFlags
function with FLAG_WITH_EXTERNAL_URL
specified yields a return value of false
.NULL
is specified for the externalUrl argument.nn::olv::EXTERNAL_URL_BUFF_LENGTH
is specified for the externalUrlMaxLength argument.[out] | externalUrl | The buffer that stores the attached URL. |
[in] | externalUrlMaxLength | The length of the buffer that stores the attached URL, including the terminating null character. Make sure that you specify a size of at least nn::olv::EXTERNAL_URL_BUFF_LENGTH . |
s8 GetFeeling | ( | ) | const |
Gets the mood.
u8 GetLanguageId | ( | ) | const |
Gets the language ID.
See nn::cfg::CfgLanguageCode
for the language IDs.
void GetMiiData | ( | nn::mii::StoreData * | storeData | ) | const |
Gets the Mii data of the user.
This function can only be used when the return value from the TestFlags
function is true
when FLAG_WITH_MII_DATA
is specified.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
TestFlags
function with FLAG_WITH_MII_DATA
specified yields a return value of false
.NULL
is specified for the storeData argument.[out] | storeData | The buffer that stores the Mii data. |
void GetMiiNickname | ( | wchar_t * | miiNickname, |
u32 | miiNicknameMaxLength | ||
) | const |
Gets the nickname of the Mii character of the user.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
NULL
is specified for the miiNickname argument.nn::olv::MII_NICKNAME_BUFF_LENGTH
is specified for the miiNicknameMaxLength argument.[out] | miiNickname | The buffer that stores the nickname of the Mii character. |
[in] | miiNicknameMaxLength | The length of the buffer that stores the nickname of the Mii character, including the terminating null character. Make sure that you specify a size of at least nn::olv::MII_NICKNAME_BUFF_LENGTH . |
u8 GetPlatformId | ( | ) | const |
Gets the platform ID.
nn::fnd::DateTime GetPostDate | ( | ) | const |
Gets the date the post was made.
The date returned reflects the difference in the time zone of the account.
void GetPostId | ( | char * | postId, |
u32 | postIdMaxLength | ||
) | const |
Gets the post ID.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
NULL
is specified for the postId argument.nn::olv::POST_ID_BUFF_LENGTH
is specified for the postIdMaxLength argument.[out] | postId | The buffer that stores the post ID. |
[in] | postIdMaxLength | The length of the buffer that stores the post ID, including the terminating null character. Make sure that you specify a size of at least nn::olv::POST_ID_BUFF_LENGTH . |
u32 GetRegionId | ( | ) | const |
Gets the region ID.
void GetTopicTag | ( | wchar_t * | topicTag, |
u32 | topicTagMaxLength | ||
) | const |
Gets topic tags.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
NULL
is specified for the topicTag argument.nn::olv::TOPIC_TAG_BUFF_LENGTH
is specified for the topicTagMaxLength argument.[out] | topicTag | The buffer that stores the topic tags. |
[in] | topicTagMaxLength | The length of the buffer that stores the topic tags, including the terminating null character. Make sure that you specify a size of at least nn::olv::TOPIC_TAG_BUFF_LENGTH . |
u32 GetUserPid | ( | ) | const |
Gets the principal ID of the user.
bool TestFlags | ( | u32 | flags | ) | const |
Tests flags.
[in] | flags | Flags (FLAG_* ). |
true
if any of the flags are set; returns false
otherwise.