Nintendo 3DS Miiverse Library  1.3.2
(OLV/Olive)
nn::olv Namespace Reference

olv More...

Classes

class  ConnectedData
 A class that stores the connection results. More...
 
class  ConnectParam
 Represents the parameters when connecting. More...
 
class  DownloadCommentDataListParam
 Represents the parameters when downloading comment data. More...
 
class  DownloadCommunityDataListParam
 Represents the parameters when downloading community data. More...
 
class  DownloadedCommentData
 A class that stores the downloaded comment data. More...
 
class  DownloadedCommunityData
 A class that stores the downloaded community data. More...
 
class  DownloadedPostData
 A class that stores the downloaded post data. More...
 
class  DownloadedTopicData
 A class that stores the downloaded topic data. More...
 
class  DownloadedUserData
 The class for storing the downloaded user data. More...
 
class  DownloadPostDataListParam
 Represents the parameters when downloading post data. More...
 
class  DownloadUserDataListParam
 The class representing the parameters used when downloading user data. More...
 
class  InitializedData
 The class that stores the results when the OLV library is initialized. More...
 
class  InitializeParam
 Represents the parameters when initializing the OLV library. More...
 
class  ResultCanceled
 Canceled. More...
 
class  ResultFatalError
 Fatal error. More...
 
class  ResultLibraryError
 Library error. More...
 
class  ResultLibraryPermanentError
 Permanent library error. More...
 
class  ResultLibraryTemporaryError
 Temporary library error. More...
 
class  ResultNetworkDataError
 Network data error. More...
 
class  ResultNetworkError
 Network error. More...
 
class  ResultNetworkHttpError
 HTTP error. More...
 
class  ResultNetworkLibraryError
 Network library error. More...
 
class  ResultServerError
 Server error. More...
 
class  ResultServerPermanentError
 Permanent server error. More...
 
class  ResultServerTemporaryError
 Temporary server error. More...
 
class  ResultUsageError
 Usage error. More...
 
class  ResumedData
 A class that stores the recovery results. More...
 
class  ResumeParam
 Represents the parameters when recovering. More...
 
class  StartPortalAppParam
 Represents the parameters when starting the Miiverse application. More...
 
class  UploadCommunityDataParam
 The class representing the parameters used when creating, updating, and deleting community data. More...
 
class  UploadedCommunityData
 The class for storing the results when community data is created or uploaded. More...
 
class  UploadEmpathyToPostDataParam
 The class representing the parameters used when uploading a Yeah to a post or removing a Yeah. More...
 
class  UploadFavoriteToCommunityDataParam
 The class representing the parameters used when registering a favorite to a community or removing a favorite. More...
 
class  UploadFollowToUserDataParam
 The class representing the parameters used when following users and canceling the following of users. More...
 

Enumerations

enum  CommonDataType { ,
  COMMON_DATA_TYPE_BODY_TEXT,
  COMMON_DATA_TYPE_BODY_TEXT_MAX_LENGTH,
  COMMON_DATA_TYPE_BODY_MEMO,
  COMMON_DATA_TYPE_FEELING,
  COMMON_DATA_TYPE_APP_DATA,
  COMMON_DATA_TYPE_EXTERNAL_IMAGE,
  COMMON_DATA_TYPE_EXTERNAL_THUMBNAIL_IMAGE,
  COMMON_DATA_TYPE_STAMP,
  COMMON_DATA_TYPE_EXTERNAL_URL,
  COMMON_DATA_TYPE_TOPIC_TAG,
  COMMON_DATA_TYPE_SEARCH_KEY,
  COMMON_DATA_TYPE_COMMUNITY_ID,
  COMMON_DATA_TYPE_POST_ID,
  COMMON_DATA_TYPE_COMMENT_ID,
  COMMON_DATA_TYPE_USER_PID,
  COMMON_DATA_TYPE_RESULT
}
 Enumerated type representing data types. More...
 
enum  Feeling {
  FEELING_NORMAL,
  FEELING_HAPPY,
  FEELING_LIKE,
  FEELING_SURPRISED,
  FEELING_FRUSTRATED,
  FEELING_PUZZLED
}
 Enumerates the moods. More...
 

Functions

nn::olv::Result Cancel ()
 Cancels the Internet communication process. More...
 
nn::olv::Result Connect (nn::olv::ConnectedData *connectedData, const nn::olv::ConnectParam *connectParam)
 Processes OLV library connections. More...
 
nn::olv::Result DownloadCommentDataList (nn::olv::DownloadedCommentData *commentDataList, u32 *downloadedCommentDataNum, const nn::olv::DownloadCommentDataListParam *downloadParam)
 Downloads comment data. More...
 
nn::olv::Result DownloadCommunityDataList (nn::olv::DownloadedCommunityData *communityDataList, u32 *downloadedCommunityDataNum, const nn::olv::DownloadCommunityDataListParam *downloadParam)
 Downloads community data. More...
 
nn::olv::Result DownloadPostDataList (nn::olv::DownloadedTopicData *topicData, nn::olv::DownloadedPostData *postDataList, u32 *downloadedPostDataNum, const nn::olv::DownloadPostDataListParam *downloadParam)
 Downloads post data. More...
 
nn::olv::Result DownloadUserDataList (nn::olv::DownloadedUserData *userDataList, u32 *downloadedUserDataNum, const nn::olv::DownloadUserDataListParam *downloadParam)
 Downloads user data. More...
 
void Finalize ()
 Finalizes the OLV library.
 
u32 GetErrorCode (const nn::olv::Result &result)
 Gets the error code. More...
 
nn::olv::Result Initialize (nn::olv::InitializedData *initializedData, const nn::olv::InitializeParam *initializeParam)
 Initializes the OLV library. More...
 
bool IsConnected ()
 Determines whether the OLV library has been connected to. More...
 
bool IsInitialized ()
 Determines whether the OLV library has been initialized. More...
 
nn::olv::Result Resume (nn::olv::ResumedData *resumedData, const nn::olv::ResumeParam *resumeParam)
 Handles recovery operations. More...
 
nn::olv::Result StartPortalApp (const nn::olv::StartPortalAppParam *startParam)
 Starts the Miiverse application. More...
 
nn::olv::Result UploadCommunityData (nn::olv::UploadedCommunityData *uploadedData, const nn::olv::UploadCommunityDataParam *uploadParam)
 Creates, updates, or deletes community data. More...
 
nn::olv::Result UploadEmpathyToPostData (const nn::olv::UploadEmpathyToPostDataParam *uploadParam)
 Gives a Yeah to a post or removes a Yeah from a post. More...
 
nn::olv::Result UploadFavoriteToCommunityData (const nn::olv::UploadFavoriteToCommunityDataParam *uploadParam)
 Registers a community as a favorite or removes a community as a favorite. More...
 
nn::olv::Result UploadFollowToUserData (const nn::olv::UploadFollowToUserDataParam *uploadParam)
 Uploads whether to follow a user or to stop following a user. More...
 

Variables

static const int APP_DATA_BUFF_LENGTH = 1024
 The size of the buffer for the application data.
 
static const int BANNER_DATA_BUFF_LENGTH = 512 * 1024
 The size of the buffer for banner data.
 
static const int BODY_MEMO_BUFF_LENGTH = 4864
 The buffer size of the handwritten memo data.
 
static const int BODY_MEMO_HEIGHT = 120
 The height of the handwritten memo data.
 
static const int BODY_MEMO_WIDTH = 320
 The width of the handwritten memo data.
 
static const int BODY_TEXT_BUFF_LENGTH = 256
 The length of the buffer for the text data, including the terminating null character.
 
static const int BODY_TEXT_MAX_LENGTH = 255
 The maximum length of the text data, excluding the terminating null character.
 
static const int COMMENT_ID_BUFF_LENGTH = 32
 The length of the buffer for the comment ID, including the terminating null character.
 
static const int COMMUNITY_CODE_BUFF_LENGTH = 13
 The length of the buffer for the community code, including the terminating null character.
 
static const u32 COMMUNITY_ID_ALL_OFFICIAL = 0xFFFFFFFF
 Community IDs representing all official communities.
 
static const int COMMUNITY_ID_MAX_NUM = 30
 The maximum number of community IDs that can be specified when downloading community data.
 
static const int COMPRESSED_BODY_MEMO_BUFF_LENGTH = BODY_MEMO_BUFF_LENGTH + 32
 The buffer size of the handwritten memo data after compression.
 
static const int COMPRESSED_ICON_DATA_BUFF_LENGTH = 9 * 1024 + 44
 The size of the buffer for the community icon data after compression.
 
static const int COMPRESSED_ICON_DATA_BUFF_LENGTH_WIIU = 64 * 1024 + 44
 The size of the buffer for the compressed Wii U community icon data.
 
static const int DESCRIPTION_TEXT_BUFF_LENGTH = 256
 The length of the buffer for the community description, including the terminating null character.
 
static const int EXTERNAL_IMAGE_DATA_MAX_LENGTH = 512 * 1024
 The maximum size of the attached image data.
 
static const int EXTERNAL_IMAGE_DATA_TOTAL_MAX_LENGTH = 512 * 1024
 The maximum combined size of the attached image data and the attached thumbnail image data.
 
static const int EXTERNAL_THUMBNAIL_IMAGE_DATA_MAX_LENGTH = 128 * 1024
 The maximum size of the attached thumbnail image data.
 
static const int EXTERNAL_URL_BUFF_LENGTH = 256
 The length of the buffer for the attached URL, including the terminating null character.
 
static const int HOST_NAME_BUFF_LENGTH = 256
 The length of the buffer for the hostname, including the terminating null character.
 
static const int ICON_DATA_BUFF_LENGTH = 9 * 1024 + 44
 The size of the buffer for the community icon data.
 
static const int ICON_DATA_BUFF_LENGTH_WIIU = 64 * 1024 + 44
 The size of the buffer for the Wii U community icon data.
 
static const u8 LANGUAGE_ID_ALL = 0xFE
 Language IDs representing all languages.
 
static const int MII_DATA_BUFF_LENGTH = 96
 The size of the buffer for the Mii data.
 
static const int MII_NICKNAME_BUFF_LENGTH = 32
 The length of the buffer for the nickname of the Mii character, including the terminating null character.
 
static const int PARAM_PACK_BUFF_LENGTH = 512
 The length of the buffer for the parameter pack, including the terminating null character.
 
static const u32 PORTAL_APP_APPLET_ID = 0x117
 The applet ID for the Miiverse application.
 
static const int POST_ID_BUFF_LENGTH = 32
 The length of the buffer for the post ID, including the terminating null character.
 
static const int POST_ID_MAX_NUM = 20
 The maximum number of post IDs that can be specified when downloading posts.
 
static const int SEARCH_KEY_BUFF_LENGTH = 151 + 1
 The length of the buffer for the search key, including the terminating null character.
 
static const int SEARCH_KEY_MAX_LENGTH = 50
 The maximum length of the search key, excluding the terminating null character.
 
static const int SEARCH_KEY_MAX_NUM = 5
 The maximum number of search keys that can be specified when uploading posts.
 
static const int SYSTEM_ARGS_COMMON_STRING_BUFF_LENGTH = 512
 The length of the buffer for the system argument common strings, including the terminating null character.
 
static const int TITLE_TEXT_BUFF_LENGTH = 128
 The length of the buffer for the community name, including the terminating null character.
 
static const int TOPIC_TAG_BUFF_LENGTH = 151 + 1
 The length of the buffer for the topic tag, including the terminating null character.
 
static const int TOPIC_TAG_MAX_LENGTH = 50
 The maximum length of the topic tag, excluding the terminating null character.
 
static const int URL_BUFF_LENGTH = 2048
 The length of the buffer for the URL, including the terminating null character.
 
static const int USER_AGENT_BUFF_LENGTH = 64
 The length of the buffer for the user agent, including the terminating null character.
 

Detailed Description

olv

Function Documentation

nn::olv::Result nn::olv::Cancel ( )

Cancels the Internet communication process.

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.

Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::Connect ( nn::olv::ConnectedData connectedData,
const nn::olv::ConnectParam connectParam 
)

Processes OLV library connections.

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.

Parameters
[out]connectedDataThe class that stores the connection results.
[in]connectParamThe class that stores the parameters used for the connection.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::DownloadCommentDataList ( nn::olv::DownloadedCommentData commentDataList,
u32 *  downloadedCommentDataNum,
const nn::olv::DownloadCommentDataListParam downloadParam 
)

Downloads comment data.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[out]commentDataListAn array of classes that store the downloaded comment data.
Specify the number of arrays using the nn::olv::DownloadCommentDataListParam::SetCommentDataMaxNum function in the downloadParam parameter.
[out]downloadedCommentDataNumThe buffer that stores the amount of downloaded comment data.
[in]downloadParamThe class that stores the parameters used when downloading comments.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::DownloadCommunityDataList ( nn::olv::DownloadedCommunityData communityDataList,
u32 *  downloadedCommunityDataNum,
const nn::olv::DownloadCommunityDataListParam downloadParam 
)

Downloads community data.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[out]communityDataListAn array of classes that store the downloaded community data.
Specify the number of arrays in the downloadParam argument of the nn::olv::DownloadCommunityDataListParam::SetCommunityDataMaxNum function.
[out]downloadedCommunityDataNumThe buffer that stores the number of downloaded communities.
[in]downloadParamThe class that stores the parameters used when downloading community data.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::DownloadPostDataList ( nn::olv::DownloadedTopicData topicData,
nn::olv::DownloadedPostData postDataList,
u32 *  downloadedPostDataNum,
const nn::olv::DownloadPostDataListParam downloadParam 
)

Downloads post data.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[out]topicDataThe class that stores the downloaded topic tags.
[out]postDataListAn array of classes that stores the downloaded post data.
Specify the number of arrays in the downloadParam argument of the nn::olv::DownloadPostDataListParam::SetPostDataMaxNum function.
[out]downloadedPostDataNumThe buffer that stores the number of downloaded posts.
[in]downloadParamThe class that stores the parameters used when downloading posts.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::DownloadUserDataList ( nn::olv::DownloadedUserData userDataList,
u32 *  downloadedUserDataNum,
const nn::olv::DownloadUserDataListParam downloadParam 
)

Downloads user data.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[out]userDataListAn array of classes that store the downloaded user data.
Specify the number of arrays using the nn::olv::DownloadUserDataListParam::SetUserDataMaxNum function in the downloadParam parameter.
[out]downloadedUserDataNumThe buffer that stores the amount of downloaded user data.
[in]downloadParamThe class that stores the parameters used when downloading user data.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
u32 nn::olv::GetErrorCode ( const nn::olv::Result &  result)

Gets the error code.

This function is thread safe.

Parameters
[in]resultSpecifies the result obtained from the OLV library API.
Returns
Returns the error code corresponding to the specified result.
Returns 0 if the specified result is not from the OLV library API.
Return values
0There are no OLV-related corresponding error codes.
Anythingelse The error code.
nn::olv::Result nn::olv::Initialize ( nn::olv::InitializedData initializedData,
const nn::olv::InitializeParam initializeParam 
)

Initializes the OLV library.

You must call this function before calling any of the functions in the nn::olv namespace.
Note that the working buffer specified for the initializeParam argument with the nn::olv::InitializeParam::SetWork function must not be cleared until the nn::olv::Finalize function is called.

  • OLV Access Key Settings
    To use the OLV library at the development stage, configure and build the application with the unique ID issued by Nintendo, and then set the OLV access key issued by Nintendo using the CTR Config tool before starting the application. This prevents people who are not involved in application development from posting to the viewable communities.
Parameters
[out]initializedDataThe class that stores the initialization results.
[in]initializeParamThe class that stores the parameters used for initialization.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
bool nn::olv::IsConnected ( )

Determines whether the OLV library has been connected to.

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.

Returns
Returns true if the library has been connected to, and false otherwise.
bool nn::olv::IsInitialized ( )

Determines whether the OLV library has been initialized.

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.

Returns
Returns true if the library is initialized, and false otherwise.
nn::olv::Result nn::olv::Resume ( nn::olv::ResumedData resumedData,
const nn::olv::ResumeParam resumeParam 
)

Handles recovery operations.

Call this function when the start event of the application comes after the OLV library has been initialized or the nn::olv::StartPortalApp function has been called.
If system parameters are being passed from the Miiverse application, that data can be received.

Parameters
[out]resumedDataThe class that stores the recovery process results.
[in]resumeParamThe class that stores the parameters used for the recovery process.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::StartPortalApp ( const nn::olv::StartPortalAppParam startParam)

Starts the Miiverse application.

If this function succeeds, you must call the nn::applet::WaitForStarting function to wait for the start event of the application.
Note that the working buffer specified for the startParam argument with the nn::olv::StartPortalAppParam::SetWork function must not be cleared until either the nn::olv::Resume or the nn::olv::Finalize function is called after the start event of the application.

Parameters
[in]startParamThe class that stores the parameters used when starting the Miiverse application.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::UploadCommunityData ( nn::olv::UploadedCommunityData uploadedData,
const nn::olv::UploadCommunityDataParam uploadParam 
)

Creates, updates, or deletes community data.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[out]uploadedDataThe class that stores the results of creating or updating community data.
You can specify NULL if not needed.
Nothing is stored if the community data is deleted.
[in]uploadParamThe class that stores the parameters used when sending community data.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::UploadEmpathyToPostData ( const nn::olv::UploadEmpathyToPostDataParam uploadParam)

Gives a Yeah to a post or removes a Yeah from a post.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[in]uploadParamThe class that stores the parameters used when giving a Yeah to a post or removing a Yeah from a post.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::UploadFavoriteToCommunityData ( const nn::olv::UploadFavoriteToCommunityDataParam uploadParam)

Registers a community as a favorite or removes a community as a favorite.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[in]uploadParamThe class that stores the parameters used when registering a community as a favorite or removing a community as a favorite.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.
nn::olv::Result nn::olv::UploadFollowToUserData ( const nn::olv::UploadFollowToUserDataParam uploadParam)

Uploads whether to follow a user or to stop following a user.

This function can only be used when a connection to the OLV library has already been made with the nn::olv::Connect function.
This function initiates 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.

Parameters
[in]uploadParamThe class that stores the parameters when uploading to follow a user or to stop following a user.
Returns
Returns the result of the operation.
For information about how to handle the results, see the OLV library reference.