Wrapper for using the MyPage (friends) LibraryApplet. More...

#include "../types.h"
#include "../services/acc.h"
#include "../services/friends.h"

Data Structures
struct	FriendsLaArgHeader
	Header for the arg struct. More...

struct	FriendsLaArgCommonData
	Common data for the arg struct, for the pre-9.0.0 types. More...

struct	FriendsLaArgV1
	Arg struct pushed for the applet input storage, for pre-9.0.0. More...

struct	FriendsLaArg
	Arg struct pushed for the applet input storage, for [9.0.0+]. More...

Enumerations
enum	FriendsLaArgType { FriendsLaArgType_ShowFriendList = 0 , FriendsLaArgType_ShowUserDetailInfo = 1 , FriendsLaArgType_StartSendingFriendRequest = 2 , FriendsLaArgType_ShowMethodsOfSendingFriendRequest = 3 , FriendsLaArgType_StartFacedFriendRequest = 4 , FriendsLaArgType_ShowReceivedFriendRequestList = 5 , FriendsLaArgType_ShowBlockedUserList = 6 , FriendsLaArgType_ShowMyProfile = 7 , FriendsLaArgType_StartFriendInvitation = 8 , FriendsLaArgType_StartSendingFriendInvitation = 9 , FriendsLaArgType_ShowReceivedInvitationDetail = 10 }
	Arg type values used with FriendsLaArg. More...

Functions
Result	friendsLaShowFriendList (AccountUid uid)
	Launches the applet with FriendsLaArgType_ShowFriendList, the specified input, and playStartupSound=false.

Result	friendsLaShowUserDetailInfo (AccountUid uid, AccountNetworkServiceAccountId id, const FriendsInAppScreenName first_inAppScreenName, const FriendsInAppScreenName second_inAppScreenName)
	Launches the applet with FriendsLaArgType_ShowUserDetailInfo, the specified input, and playStartupSound=false.

Result	friendsLaStartSendingFriendRequest (AccountUid uid, AccountNetworkServiceAccountId id, const FriendsInAppScreenName first_inAppScreenName, const FriendsInAppScreenName second_inAppScreenName)
	Launches the applet with FriendsLaArgType_StartSendingFriendRequest, the specified input, and playStartupSound=false.

Result	friendsLaShowMethodsOfSendingFriendRequest (AccountUid uid)
	Launches the applet with FriendsLaArgType_ShowMethodsOfSendingFriendRequest, the specified input, and playStartupSound=false.

Result	friendsLaStartFacedFriendRequest (AccountUid uid)
	Launches the applet with FriendsLaArgType_StartFacedFriendRequest, the specified input, and playStartupSound=false.

Result	friendsLaShowReceivedFriendRequestList (AccountUid uid)
	Launches the applet with FriendsLaArgType_ShowReceivedFriendRequestList, the specified input, and playStartupSound=false.

Result	friendsLaShowBlockedUserList (AccountUid uid)
	Launches the applet with FriendsLaArgType_ShowBlockedUserList, the specified input, and playStartupSound=false.

Result	friendsLaShowMyProfile (AccountUid uid)
	Launches the applet with FriendsLaArgType_ShowMyProfile, the specified input, and playStartupSound=false.

Result	friendsLaShowMyProfileForHomeMenu (AccountUid uid)
	Same as friendsLaShowMyProfile except with playStartupSound=true.

Result	friendsLaStartFriendInvitation (AccountUid uid, s32 id_count, const FriendsFriendInvitationGameModeDescription desc, const void userdata, u64 userdata_size)
	Launches the applet with FriendsLaArgType_StartFriendInvitation, the specified input, and playStartupSound=false.

Result	friendsLaStartSendingFriendInvitation (AccountUid uid, const AccountNetworkServiceAccountId id_list, s32 id_count, const FriendsFriendInvitationGameModeDescription desc, const void *userdata, u64 userdata_size)
	Launches the applet with FriendsLaArgType_StartSendingFriendInvitation, the specified input, and playStartupSound=false.

Result	friendsLaShowReceivedInvitationDetail (AccountUid uid, FriendsFriendInvitationId invitation_id, FriendsFriendInvitationGroupId invitation_group_id)
	Launches the applet with FriendsLaArgType_ShowReceivedInvitationDetail, the specified input, and playStartupSound=false.

Detailed Description

Wrapper for using the MyPage (friends) LibraryApplet.

Author: yellows8

Copyright: libnx Authors

Enumeration Type Documentation

◆ FriendsLaArgType

enum FriendsLaArgType

Arg type values used with FriendsLaArg.

Enumerator
FriendsLaArgType_ShowFriendList	ShowFriendList. Launches the applet with the "Friend List" menu initially selected.
FriendsLaArgType_ShowUserDetailInfo	ShowUserDetailInfo.
FriendsLaArgType_StartSendingFriendRequest	StartSendingFriendRequest.
FriendsLaArgType_ShowMethodsOfSendingFriendRequest	ShowMethodsOfSendingFriendRequest. Launches the applet with the "Add Friend" menu initially selected.
FriendsLaArgType_StartFacedFriendRequest	StartFacedFriendRequest. Launches the applet where the "Search for Local Users" menu is initially shown. Returning from this menu will exit the applet.
FriendsLaArgType_ShowReceivedFriendRequestList	ShowReceivedFriendRequestList. Launches the applet where the "Received Friend Requests" menu is initially shown. Returning from this menu will exit the applet.
FriendsLaArgType_ShowBlockedUserList	ShowBlockedUserList. Launches the applet where the "Blocked-User List" menu is initially shown. Returning from this menu will exit the applet.
FriendsLaArgType_ShowMyProfile	ShowMyProfile. Launches the applet with the "Profile" menu initially selected. ShowMyProfileForHomeMenu is identical to this except for playStartupSound=true.
FriendsLaArgType_StartFriendInvitation	[9.0.0+] StartFriendInvitation. Launches the applet for sending online-play invites to friends, where the friends are selected via the UI.
FriendsLaArgType_StartSendingFriendInvitation	[9.0.0+] StartSendingFriendInvitation.
FriendsLaArgType_ShowReceivedInvitationDetail	[9.0.0+] ShowReceivedInvitationDetail.

Function Documentation

◆ friendsLaShowBlockedUserList()

Result friendsLaShowBlockedUserList ( AccountUid uid )

Launches the applet with FriendsLaArgType_ShowBlockedUserList, the specified input, and playStartupSound=false.

Parameters

[in] uid AccountUid

◆ friendsLaShowFriendList()

Result friendsLaShowFriendList ( AccountUid uid )

Launches the applet with FriendsLaArgType_ShowFriendList, the specified input, and playStartupSound=false.

Parameters

[in] uid AccountUid

◆ friendsLaShowMethodsOfSendingFriendRequest()

Result friendsLaShowMethodsOfSendingFriendRequest ( AccountUid uid )

Launches the applet with FriendsLaArgType_ShowMethodsOfSendingFriendRequest, the specified input, and playStartupSound=false.

Parameters

[in] uid AccountUid

◆ friendsLaShowMyProfile()

Result friendsLaShowMyProfile ( AccountUid uid )

Launches the applet with FriendsLaArgType_ShowMyProfile, the specified input, and playStartupSound=false.

Parameters

[in] uid AccountUid

◆ friendsLaShowMyProfileForHomeMenu()

Result friendsLaShowMyProfileForHomeMenu ( AccountUid uid )

Same as friendsLaShowMyProfile except with playStartupSound=true.

Parameters

[in] uid AccountUid

◆ friendsLaShowReceivedFriendRequestList()

Result friendsLaShowReceivedFriendRequestList ( AccountUid uid )

Launches the applet with FriendsLaArgType_ShowReceivedFriendRequestList, the specified input, and playStartupSound=false.

Parameters

[in] uid AccountUid

◆ friendsLaShowReceivedInvitationDetail()

Result friendsLaShowReceivedInvitationDetail	(	AccountUid	uid,
		FriendsFriendInvitationId	invitation_id,
		FriendsFriendInvitationGroupId	invitation_group_id
	)

Launches the applet with FriendsLaArgType_ShowReceivedInvitationDetail, the specified input, and playStartupSound=false.

Note: Only available on [9.0.0+].

Parameters

[in]	uid	AccountUid
[in]	invitation_id	FriendsFriendInvitationId
[in]	invitation_group_id	FriendsFriendInvitationGroupId

◆ friendsLaShowUserDetailInfo()

Result friendsLaShowUserDetailInfo	(	AccountUid	uid,
		AccountNetworkServiceAccountId	id,
		const FriendsInAppScreenName *	first_inAppScreenName,
		const FriendsInAppScreenName *	second_inAppScreenName
	)

Launches the applet with FriendsLaArgType_ShowUserDetailInfo, the specified input, and playStartupSound=false.

Parameters

[in]	uid	AccountUid
[in]	id	AccountNetworkServiceAccountId for the user to show UserDetailInfo for.
[in]	first_inAppScreenName	First FriendsInAppScreenName.
[in]	second_inAppScreenName	Second FriendsInAppScreenName.

◆ friendsLaStartFacedFriendRequest()

Result friendsLaStartFacedFriendRequest ( AccountUid uid )

Launches the applet with FriendsLaArgType_StartFacedFriendRequest, the specified input, and playStartupSound=false.

Parameters

[in] uid AccountUid

◆ friendsLaStartFriendInvitation()

Result friendsLaStartFriendInvitation	(	AccountUid	uid,
		s32	id_count,
		const FriendsFriendInvitationGameModeDescription *	desc,
		const void *	userdata,
		u64	userdata_size
	)

Launches the applet with FriendsLaArgType_StartFriendInvitation, the specified input, and playStartupSound=false.

On success, this will load the output Result from the output storage.

Note: Only available on [9.0.0+].

Parameters

[in]	uid	AccountUid
[in]	id_count	AccountNetworkServiceAccountId count, must be 1-15. Number of friends to invite.
[in]	desc	FriendsFriendInvitationGameModeDescription
[in]	userdata	Arbitrary user-data. Can be NULL.
[in]	userdata_size	User-data size, must be <=0x400. Can be 0 if userdata is NULL.

◆ friendsLaStartSendingFriendInvitation()

Result friendsLaStartSendingFriendInvitation	(	AccountUid	uid,
		const AccountNetworkServiceAccountId *	id_list,
		s32	id_count,
		const FriendsFriendInvitationGameModeDescription *	desc,
		const void *	userdata,
		u64	userdata_size
	)

Launches the applet with FriendsLaArgType_StartSendingFriendInvitation, the specified input, and playStartupSound=false.

On success, this will load the output Result from the output storage.

Note: Only available on [9.0.0+].

Parameters

[in]	uid	AccountUid
[in]	id_list	AccountNetworkServiceAccountId list.
[in]	id_count	Size of the id_list array in entries, must be 1-15. Number of friends to invite.
[in]	desc	FriendsFriendInvitationGameModeDescription
[in]	userdata	Arbitrary user-data. Can be NULL.
[in]	userdata_size	User-data size, must be <=0x400. Can be 0 if userdata is NULL.

◆ friendsLaStartSendingFriendRequest()

Result friendsLaStartSendingFriendRequest	(	AccountUid	uid,
		AccountNetworkServiceAccountId	id,
		const FriendsInAppScreenName *	first_inAppScreenName,
		const FriendsInAppScreenName *	second_inAppScreenName
	)

Launches the applet with FriendsLaArgType_StartSendingFriendRequest, the specified input, and playStartupSound=false.

On success, this will load the output Result from the output storage.

Parameters

[in]	uid	AccountUid
[in]	id	AccountNetworkServiceAccountId to send the friend request to.
[in]	first_inAppScreenName	First FriendsInAppScreenName.
[in]	second_inAppScreenName	Second FriendsInAppScreenName.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ FriendsLaArgType

Function Documentation

◆ friendsLaShowBlockedUserList()

◆ friendsLaShowFriendList()

◆ friendsLaShowMethodsOfSendingFriendRequest()

◆ friendsLaShowMyProfile()

◆ friendsLaShowMyProfileForHomeMenu()

◆ friendsLaShowReceivedFriendRequestList()

◆ friendsLaShowReceivedInvitationDetail()

◆ friendsLaShowUserDetailInfo()

◆ friendsLaStartFacedFriendRequest()

◆ friendsLaStartFriendInvitation()

◆ friendsLaStartSendingFriendInvitation()

◆ friendsLaStartSendingFriendRequest()