Nintendo 3DS Miiverse Library  1.3.2
(OLV/Olive)
DownloadPostDataListParam Class Reference

Represents the parameters when downloading post data. More...

#include <CTR_SDK/include/nn/olv/olv_TypesDownloadPostData.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_EMPATHY_ADDED = (1<<7),
  FLAG_WITH_SPOILER = (1<<8)
}
 Flags that can be specified in the SetFlags function. More...
 

Public Member Functions

 DownloadPostDataListParam ()
 Instantiates the object.
 
u32 GetWorkSize () const
 Gets the size of the working buffer used by the nn::olv::DownloadPostDataList function. More...
 
void Reset ()
 Reverts parameters to their initial state.
 
void SetBodyTextMaxLength (u32 bodyTextMaxLength)
 Sets the maximum length of text data. More...
 
void SetCommunityId (u32 communityId)
 Sets the community ID. More...
 
void SetFlags (u32 flags)
 Sets flags. More...
 
void SetLanguageId (u8 languageId)
 Sets the language ID. More...
 
void SetPostDataMaxNum (u32 postDataMaxNum)
 Sets the maximum number of posts to download. More...
 
void SetPostDate (const nn::fnd::DateTime postDate)
 Sets the date the post was made. More...
 
void SetPostId (const char *postId, u32 index)
 Sets the post ID. More...
 
void SetSearchKey (const wchar_t *searchKey)
 Sets the search key. More...
 
void SetSearchPid (u32 searchPid)
 Sets the principal ID of the user. More...
 
void SetWork (u8 *work, u32 workSize)
 Sets the size of the working buffer used by the nn::olv::DownloadPostDataList function. More...
 

Detailed Description

Represents the parameters when downloading post data.

Member Enumeration Documentation

anonymous enum

Flags that can be specified in the SetFlags function.

Enumerator
FLAG_NONE 

This is the state when no flags are specified.

FLAG_FILTER_BY_FRIEND 

Download posts from users who are friends.

FLAG_FILTER_BY_FOLLOW 

Download posts from users you are following.

FLAG_FILTER_BY_SELF 

Download your own posts.

FLAG_FILTER_BY_BODY_TEXT 

Download only text posts.

FLAG_FILTER_BY_BODY_MEMO 

Download only handwritten memo posts.

FLAG_DISTINCT_PID 

Get only a single post from each user.

FLAG_WITH_MII_DATA 

Include Mii character data in the post data to download.

FLAG_WITH_EMPATHY_ADDED 

Include flags for whether you have already given Yeahs to posts in the post data to download.

FLAG_WITH_SPOILER 

Also download posts that include spoilers.

Member Function Documentation

u32 GetWorkSize ( ) const

Gets the size of the working buffer used by the nn::olv::DownloadPostDataList 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.

Returns
Returns the size of the working buffer used by the nn::olv::DownloadPostDataList 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.

Parameters
[in]bodyTextMaxLengthThe 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 SetCommunityId ( u32  communityId)

Sets the community ID.

Specifying this option is not required. If no community ID is specified, posts from the general community are downloaded.

Parameters
[in]communityIdThe community ID.
void SetFlags ( u32  flags)

Sets flags.

Specifying this option is not required.

Parameters
[in]flagsFlags (FLAG_*).
void SetLanguageId ( u8  languageId)

Sets the language ID.

Specifying this option is not required. If no language ID is specified, posts in the language set in the System Settings are downloaded.
See nn::cfg::CfgLanguageCode for the language IDs.
Specify nn::olv::LANGUAGE_ID_ALL to download posts in all languages.

Parameters
[in]languageIdThe language ID.
void SetPostDataMaxNum ( u32  postDataMaxNum)

Sets the maximum number of posts to download.

You must specify this option.

Parameters
[in]postDataMaxNumThe maximum number of posts to download.
If you specify post IDs with the SetPostId function, make sure that you specify the number of posts greater than the number of the post IDs specified to download.
Make sure that you specify a value equal to or greater than this maximum value for the number of arrays in the postDataList argument to the nn::olv::DownloadPostDataList function.
void SetPostDate ( const nn::fnd::DateTime  postDate)

Sets the date the post was made.

Specifying this option is not required.
If you specify a date, only posts that were made prior to the specified date are downloaded.
Specify a date that adjusts for the difference from the time zone of the account.

Parameters
[in]postDateThe date the post was made.
void SetPostId ( const char *  postId,
u32  index 
)

Sets the post ID.

Specifying this option is not required.
If you specify a post ID, only the post with the specified ID is downloaded.
Up to a maximum of nn::olv::POST_ID_MAX_NUM post IDs can be specified.

Parameters
[in]postIdThe post ID.
The maximum number of characters that can be specified is nn::olv::POST_ID_BUFF_LENGTH - 1.
[in]indexThe index.
The range of values that can be specified is from 0 to nn::olv::POST_ID_MAX_NUM - 1.
void SetSearchKey ( const wchar_t *  searchKey)

Sets the search key.

Specifying this option is not required.
If you specify a search key, only posts with the specified search key are downloaded.

Parameters
[in]searchKeyThe search key.
Use UTF-16LE for the encoding.
The maximum number of characters that can be specified is nn::olv::SEARCH_KEY_MAX_LENGTH.
void SetSearchPid ( u32  searchPid)

Sets the principal ID of the user.

Specifying this option is not required.
If you specify a principal ID, only the posts from the user with the specified principal ID are downloaded.

Parameters
[in]searchPidThe principal ID of the user.
void SetWork ( u8 *  work,
u32  workSize 
)

Sets the size of the working buffer used by the nn::olv::DownloadPostDataList function.

You must specify this option.
Specify a buffer of at least the size obtained with the GetWorkSize function.

Parameters
[in]workThe working buffer.
[in]workSizeThe size of the working buffer.

The documentation for this class was generated from the following file: