1 /*---------------------------------------------------------------------------* 2 3 Copyright (C) Nintendo. All rights reserved. 4 5 These coded instructions, statements, and computer programs contain 6 proprietary information of Nintendo of America Inc. and/or Nintendo 7 Company Ltd., and are protected by Federal copyright law. They may 8 not be disclosed to third parties or copied or duplicated in any form, 9 in whole or in part, without the prior written consent of Nintendo. 10 11 *---------------------------------------------------------------------------*/ 12 13 #ifndef __ACT_H__ 14 #define __ACT_H__ 15 16 17 /*! 18 @defgroup nn_act Account (ACT) Library 19 @brief Library for using account features. 20 21 @section nn_act_overview Overview 22 The account library provides features for getting information registered with the Wii U account system and authenticating users based on registered information. 23 Because creating and editing accounts and entering information required for authentication is handled on the system menu of the product or by a development tool, applications do not need to support these sequences. 24 For more information about the Wii U account system, see the <a href="../../Doc/WiiUAccountSystemDevelopersGuide/index.html">Wii U Account System Developer's Guide</a> included in the SDK. 25 26 @section nn_act_communication Using API Functions That Trigger Communication 27 Use the following code when using functions that perform authentication by communicating with the account server, such as <tt>@ref nn::act::AcquireIndependentServiceToken</tt> and <tt>@ref nn::act::AcquireEcServiceToken</tt>. 28 Also, refer to the <tt>serviceToken</tt> and <tt>cancel</tt> demos. 29 The API functions that trigger communication are clearly marked as such in the function reference. 30 If the function description does not clearly say that the function triggers communication, it does not. 31 32 @subsection nn_act_communication_connect Requesting Network Connections 33 Use the <tt>@ref nn::ac::Connect</tt> or <tt>@ref nn::ac::ConnectAsync</tt> function of the automatic connection (AC) library to connect to the network and check that connection succeeds before calling an account library function. 34 35 @subsection nn_act_communication_errorhandling Error Handling 36 37 @subsubsection nn_act_communication_errorhandling_display Error Displays 38 If connection to the network fails, display an error according to the rules for using the AC library. @n 39 If an account library function fails after successfully connecting to the network, get the error code using the <tt>@ref nn::act::GetErrorCode</tt> function, and display the error using the Error Viewer. 40 41 @subsubsection nn_act_communication_errorhandling_branching Branching Processes 42 The <tt>@ref nn::Result</tt> objects or error codes returned by API functions may be expanded by future changes. 43 If application execution branches based on the reason for an error, take the following steps to maintain forward compatibility. @n 44 @li Always determine branching by handling the <tt>@ref nn::Result</tt> object returned by the API functions. Do not branch execution by looking at the value of the error code. 45 @li The determination of the <tt>@ref nn::Result</tt> object is performed according to the inclusion relationship (<=, >=, Includes). 46 47 @section nn_act_reactivity Notes on Responsiveness 48 All API functions in the account library (even ones that do not result in communication) may result in poor responsiveness because of increased system load if the higher priority APIs are called frequently. 49 Calling these functions from the main loop may slow down processing. 50 51 @section nn_act_synchronization Notes on Synchronization 52 Information registered for a Nintendo Network account that can be obtained using the account library is synchronized appropriately by the system. 53 Information may even be synchronized while an application is running, but applications do not necessarily always need to use the latest information. 54 However, users may be confused if Mii character data or their account ID changes during gameplay. Make sure that applications cache and display this information as needed. 55 56 @{ 57 58 @namespace nn::act 59 @brief Namespace for the Account (ACT) Library. 60 61 @defgroup nn_act_result Account (ACT) Library Results 62 @brief A list of <tt>Result</tt> codes used by the account library. 63 64 @} 65 */ 66 67 #include "act/act_Types.h" 68 #include "act/act_Result.h" 69 #include "act/act_Api.h" 70 71 72 #endif // __ACT_H__ 73