nn::friends::CTR NamespaceThe CTR FRIENDS namespace.
(This namespace can also be written without the ::CTR portion.)
PlatformCode
|
Enumerated type representing platform types. | |
|---|---|---|
AttributeFlag
|
Enumerated type representing friend relationships using attribute flags. | |
NotificationType
|
Enumerated type representing notification types. |
typedef Definitions
PrincipalId
|
Represents a principal ID. | |
|---|---|---|
LocalFriendCode
|
Represents a local friend code. | |
FriendKey
|
Structure for comprehensively handling users' principal IDs and local friend codes. | |
Profile
|
Structure storing a user's profile information. | |
MiiInformation
|
Structure storing a user's display name and Mii data. | |
GameMode
|
Structure storing information about the game the local host is currently playing. This information is required for friends to join. | |
MyPresence
|
Structure storing the local user's own presence information. | |
FriendPresence
|
Structure storing friend presence information. | |
EventNotification
|
Structure storing notifications of changes in the local host's online state and friends' online states. |
| S |
INVALID_PRINCIPAL_ID
|
Invalid principal ID. |
|---|---|---|
| S |
INVALID_LOCAL_FRIEND_CODE
|
Invalid local friend code. |
| S |
INVALID_FRIEND_CODE
|
Invalid friend code. |
Initialize
|
Initializes the FRIENDS library and makes the presence features available for use. | |
|---|---|---|
Finalize
|
Finalizes the FRIENDS library. | |
IsInitialized
|
Checks whether the FRIENDS library is initialized. | |
HasLoggedIn
|
Checks the login status. | |
Login
|
Requests a login to the server. | |
Logout
|
Retracts a login request to a server. | |
GetMyPrincipalId
|
Gets the local host's principal ID. | |
GetMyLocalFriendCode
|
Gets the local host's local friend code. | |
GetMyFriendKey
|
Gets the local host's friend key. | |
GetMyPreference
|
Gets the disclosure level of the local host's information. | |
GetMyProfile
|
Gets the local host's profile information. | |
GetMyPresence
|
Gets the local host's presence information. | |
GetMyMii
|
Gets the local host's Mii information. | |
GetFriendKeyList
|
Gets a list of the friend keys registered in the friend list. | |
GetFriendPresence
|
Gets a list of friend presence information. | |
GetFriendMii
|
Gets a list of friends' Mii information. | |
GetFriendProfile
|
Gets a list of friends' profile information. | |
GetFriendAttributeFlags
|
Gets a list of friend relationships. | |
IsIncludedInFriendList
|
Checks if the specified local friend code is in the friend list. | |
UpdateGameModeDescription
|
Updates the game mode description string. | |
UpdateGameMode
|
Updates the game mode. | |
SendInvitation
|
Sends friends an invitation message. | |
AttachToEventNotification
|
Specifies an event that notifies of changes in the local host's login state and friends' login states. | |
GetEventNotification
|
Gets the history of notifications of changes in the local host's online state and friends' online states. | |
GetLastResponseResult
|
Gets the result of the completed asynchronous operation. | |
FriendKeyToFriendCode
|
Generates a friend code from a friend key. | |
PrincipalIdToFriendCode
|
Generates a friend code from a principal ID. | |
FriendCodeToFriendKey
|
Gets the friend key from a friend code. | |
FriendCodeToPrincipalId
|
Gets the principal ID from a friend code. | |
IsValidFriendCode
|
Checks the validity of a friend code. | |
ResultToErrorCode
|
Gets an error code from a FRIENDS library function result. |
CONFIDENTIAL