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

The class representing the parameters used when downloading user data. More...

#include <CTR_SDK/include/nn/olv/olv_TypesDownloadUserData.h>

Public Types

enum  {
  FLAG_NONE = 0,
  FLAG_FRIEND_TO_USER = (1<<0),
  FLAG_FOLLOW_TO_USER = (1<<1),
  FLAG_EMPATHY_TO_POST = (1<<2),
  FLAG_FAVORITE_TO_COMMUNITY = (1<<3),
  FLAG_WITH_MII_DATA = (1<<4)
}
 Flags that can be specified in the SetFlags function. More...
 

Public Member Functions

 DownloadUserDataListParam ()
 Instantiates the object.
 
u32 GetWorkSize () const
 Gets the size of the working buffer to use with the nn::olv::DownloadUserDataList function. More...
 
void Reset ()
 Reverts parameters to their initial state.
 
void SetCommunityId (const u32 communityId)
 Sets the community ID. More...
 
void SetFlags (u32 flags)
 Sets flags. More...
 
void SetPostId (const char *postId)
 Sets the post ID. More...
 
void SetUserDataMaxNum (u32 userDataMaxNum)
 Sets the maximum amount of user data to download. More...
 
void SetUserPid (u32 userPid)
 Sets the principal ID. More...
 
void SetWork (u8 *work, u32 workSize)
 Specifies the size of the working buffer to use with the nn::olv::DownloadUserDataList function. More...
 

Detailed Description

The class representing the parameters used when downloading user data.

Member Enumeration Documentation

anonymous enum

Flags that can be specified in the SetFlags function.

A flag other than FLAG_NONE must be specified.
Only one flag can be specified.

Enumerator
FLAG_NONE 

This is the state when no flags are specified.

FLAG_FRIEND_TO_USER 

Downloads user data from friends of the specified user. Specify the target user with the SetUserPid function.

FLAG_FOLLOW_TO_USER 

Downloads user data from the users that the specified user is following. Specify the target user with the SetUserPid function.

FLAG_EMPATHY_TO_POST 

Downloads user data from users who have given a Yeah to the specified post. Specify the target post with the SetPostId function.

FLAG_FAVORITE_TO_COMMUNITY 

Downloads user data from users who have registered the specified community as a favorite. Specify the target community with the SetCommunityId function.

FLAG_WITH_MII_DATA 

Downloads user data including the Mii data.

Member Function Documentation

u32 GetWorkSize ( ) const

Gets the size of the working buffer to use with the nn::olv::DownloadUserDataList 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 to use with the nn::olv::DownloadUserDataList function.
void SetCommunityId ( const u32  communityId)

Sets the community ID.

Specifying this option is not required.
Specify FLAG_FAVORITE_TO_COMMUNITY at the same time.
When this is specified, the user data is downloaded for users who have registered the specified community as a favorite.

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

Sets flags.

You must specify this option.

Parameters
[in]flagsFlags (FLAG_*).
void SetPostId ( const char *  postId)

Sets the post ID.

Specifying this option is not required.
Specify FLAG_EMPATHY_TO_POST at the same time.
When this is specified, the user data is downloaded for users who have given a Yeah to the specified post.

Parameters
[in]postIdThe post ID.
The maximum number of characters that can be specified is nn::olv::POST_ID_BUFF_LENGTH - 1.
void SetUserDataMaxNum ( u32  userDataMaxNum)

Sets the maximum amount of user data to download.

You must specify this option.

Parameters
[in]userDataMaxNumThe maximum amount of user data to download.
Make sure that the number of arrays in the userDataList parameter of the nn::olv::DownloadUserDataList function is equal to or greater than this value.
void SetUserPid ( u32  userPid)

Sets the principal ID.

Specifying this option is not required.
Specify FLAG_FRIEND_TO_USER or FLAG_FOLLOW_TO_USER at the same time.
When the principal ID for some user is specified, the user data is downloaded for the friends of that user or the people being followed by that user.

Parameters
[in]userPidThe principal ID.
void SetWork ( u8 *  work,
u32  workSize 
)

Specifies the size of the working buffer to use with the nn::olv::DownloadUserDataList 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: