Research

Research

Quazal

RMC

ChallengeHelperService

Protocols

Protocol IDName
105ChallengeHelperProtocol

ChallengeHelperProtocol

Method IDSignature
1
func GenerateMyFriendChallenges(friendPIDs: qlist<uint32>) -> (result: qlist<[[FriendChallenge]]((friendchallenge))>)
2
func GenerateFriendChallenges(targetPID: uint32, friendPIDs: qlist<uint32>) -> (result: qlist<[[FriendChallenge]]((friendchallenge))>)
3
func GetOnlineChallenges() -> (onlineChallenges: qlist<[[OnlineChallenge]]((onlinechallenge))>)

GameSessionExService

Protocols

Protocol IDName
123GameSessionExProtocol

GameSessionExProtocol

Method IDSignature
1
func SearchSessions(gameSessionQuery: [[GameSessionQuery]]((gamesessionquery))) -> (searchResults: qlist<[[GameSessionSearchResultEx]]((gamesessionsearchresultex))>)

trackingextension

Protocols

Protocol IDName
1001TrackingExtensionProtocol

TrackingExtensionProtocol

Method IDSignature
1
func GetTrackingUserGroup(pid: uint32) -> (usergroup: uint32)
2
func GetTrackingUserGroupTags(usergroup: uint32) -> (tags: qvector<string>)

LadderHelperService

Protocols

Protocol IDName
107LadderHelperProtocol

LadderHelperProtocol

Method IDSignature
1
func GetUnixUTC() -> (time: uint32)
2
func AreLaddersAvailableInCountry() -> (allowed: bool)
3
func CheckLadderIsRunning(startTime: uint32, endTime: uint32) -> (running: bool)
4
func ClearLadderLeaderboard(statSet: int32) -> (success: bool)

ClanHelperService

Protocols

Protocol IDName
106ClanHelperProtocol

ClanHelperProtocol

Method IDSignature
1
func SetClanInfo(newInfo: [[ClanInfo]]((claninfo))) -> ()
2
func AddPIDToCLID(targetPID: uint32, CLID: uint32) -> ()
3
func RemoveMemberByPID(targetPID: uint32) -> ()
4
func DisbandEntireCLID(targetCLID: uint32) -> ()
5
func GetClanInfoByPID(targetPID: uint32) -> (clanInfo: [[ClanInfo]]((claninfo)))
6
func GetClanInfoByCLID(targetCLID: uint32) -> (clanInfo: [[ClanInfo]]((claninfo)))
7
func GetMemberListByPID(targetPID: uint32) -> (members: qlist<uint32>)
8
func GetMemberListByCLID(targetCLID: uint32) -> (members: qlist<uint32>)
9
func GenerateClanChallenges(targetPID: uint32) -> (result: qlist<[[FriendChallenge]]((friendchallenge))>)

OnlineCore

Protocols

STLExt

AccountManagementService

Protocols

Protocol IDName
25AccountManagementProtocol

AccountManagementProtocol

Method IDSignature
1
func CreateAccount(strPrincipalName: string, strKey: string, uiGroups: uint32, strEmail: string) -> (retval: qresult)
2
func DeleteAccount(idPrincipal: uint32) -> ()
3
func DisableAccount(idPrincipal: uint32, dtUntil: datetime, strMessage: string) -> (retval: qresult)
4
func ChangePassword(strNewKey: string) -> (retval: bool)
5
func TestCapability(uiCapability: uint32) -> (retval: bool)
6
func GetName(idPrincipal: uint32) -> (strName: string)
7
func GetAccountData() -> (retval: qresult, oAccountData: [[AccountData]]((accountdata)))
8
func GetPrivateData() -> (retval: bool, oData: any<[[Data]]((data)), string>)
9
func GetPublicData(idPrincipal: uint32) -> (retval: bool, oData: any<[[Data]]((data)), string>)
10
func GetMultiplePublicData(lstPrincipals: std_list<uint32>) -> (retval: bool, oData: std_list<any<[[Data]]((data)), string>>)
11
func UpdateAccountName(strName: string) -> (retval: qresult)
12
func UpdateAccountEmail(strName: string) -> (retval: qresult)
13
func UpdateCustomData(oPublicData: any<[[Data]]((data)), string>, oPrivateData: any<[[Data]]((data)), string>) -> (retval: qresult)
14
func FindByNameRegex(uiGroups: uint32, strRegex: string, resultRange: [[ResultRange]]((resultrange))) -> (plstAccounts: std_list<[[BasicAccountInfo]]((basicaccountinfo))>)
15
func UpdateAccountExpiryDate(idPrincipal: uint32, dtExpiry: datetime, strExpiredMessage: string) -> ()
16
func UpdateAccountEffectiveDate(idPrincipal: uint32, dtEffectiveFrom: datetime, strNotEffectiveMessage: string) -> ()
17
func UpdateStatus(strStatus: string) -> ()
18
func GetStatus(idPrincipal: uint32) -> (strStatus: string)
19
func GetLastConnectionStats(idPrincipal: uint32) -> (dtLastSessionLogin: datetime, dtLastSessionLogout: datetime, dtCurrentSessionLogin: datetime)
20
func ResetPassword() -> (retval: bool)
21
func CreateAccountWithCustomData(strPrincipalName: string, strKey: string, uiGroups: uint32, strEmail: string, oPublicData: any<[[Data]]((data)), string>, oPrivateData: any<[[Data]]((data)), string>) -> ()
22
func RetrieveAccount() -> (oAccountData: [[AccountData]]((accountdata)), oPublicData: any<[[Data]]((data)), string>, oPrivateData: any<[[Data]]((data)), string>)
23
func UpdateAccount(strKey: string, strEmail: string, oPublicData: any<[[Data]]((data)), string>, oPrivateData: any<[[Data]]((data)), string>) -> ()
24
func ChangePasswordByGuest(strPrincipalName: string, strEmail: string, strKey: string) -> ()
25
func FindByNameLike(uiGroups: uint32, strLike: string, resultRange: [[ResultRange]]((resultrange))) -> (plstAccounts: std_list<[[BasicAccountInfo]]((basicaccountinfo))>)
26
func CustomCreateAccount(strPrincipalName: string, strKey: string, uiGroups: uint32, strEmail: string, oAuthData: any<[[Data]]((data)), string>) -> (pid: uint32)
27
func LookupOrCreateAccount(strPrincipalName: string, strKey: string, uiGroups: uint32, strEmail: string, oAuthData: any<[[Data]]((data)), string>) -> (pid: uint32)
28
func CreateAccountEx(principalType: int8, strPrincipalName: string, strKey: string, uiGroups: uint32, strEmail: string, context: uint64) -> (retval: qresult)
29
func DisconnectPrincipal(idPrincipal: uint32) -> (retval: bool)
30
func DisconnectAllPrincipals() -> (retval: bool)

AuthenticationFoundation

Protocols

Protocol IDName
10TicketGrantingProtocol

TicketGrantingProtocol

Method IDSignature
1
func Login(strUserName: string) -> (retval: qresult, pidPrincipal: uint32, pbufResponse: buffer, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
2
func LoginEx(strUserName: string, oExtraData: any<[[Data]]((data)), string>) -> (retval: qresult, pidPrincipal: uint32, pbufResponse: buffer, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
3
func RequestTicket(idSource: uint32, idTarget: uint32) -> (retval: qresult, bufResponse: buffer)
4
func GetPID(strUserName: string) -> (retval: uint32)
5
func GetName(id: uint32) -> (retval: string)
6
func LoginWithContext(loginData: any<[[Data]]((data)), string>) -> (retval: qresult, pidPrincipal: uint32, pbufResponse: buffer, pConnectionData: [[RVConnectionData]]((rvconnectiondata)))

HealthService

Protocols

Protocol IDName
18HealthProtocol
19MonitoringProtocol

HealthProtocol

Method IDSignature
1
func PingDaemon() -> (retval: bool)
2
func PingDatabase() -> (retval: bool)
3
func RunSanityCheck() -> (retval: bool)
4
func FixSanityErrors() -> (retval: bool)
## MonitoringProtocol
Method IDSignature
1
func PingDaemon() -> (retval: bool)
2
func GetClusterMembers() -> (strValues: std_list<string>)

OfflineGameNotificationsService

Protocols

OfflineGameNotificationsProtocol

Method IDSignature
1
func PollNotifications() -> (listNotifications: qlist<[[NotificationEvent]]((notificationevent))>, nbRemainingNotifs: uint32)
2
func PollSpecificOfflineNotifications(majortype: qlist<uint32>) -> (listTimedNotification: qlist<[[TimedNotification]]((timednotification))>, ret: uint32)
3
func PollAnyOfflineNotifications() -> (listTimedNotification: qlist<[[TimedNotification]]((timednotification))>, nbRemainingNotifs: uint32)

WebNotificationsStorageService

Protocols

WebNotificationsStorageProtocol

Method IDSignature
1
func RegisterUser() -> ()
2
func PollNotifications() -> (listNotifications: string, nbNotifications: int32)
3
func UnregisterUser() -> ()

ProtocolFoundation

Protocols

NotificationProtocol

Method IDSignature
1
func ProcessNotificationEvent(oEvent: [[NotificationEvent]]((notificationevent))) -> ()
## RemoteLogDeviceProtocol
Method IDSignature
1
func Log(strLine: string) -> ()

SecureConnectionService

Protocols

Protocol IDName
11SecureConnectionProtocol

SecureConnectionProtocol

Method IDSignature
1
func Register(vecMyURLs: std_list<stationurl>) -> (retval: qresult, pidConnectionID: uint32, urlPublic: stationurl)
2
func RequestConnectionData(cidTarget: uint32, pidTarget: uint32) -> (retval: bool, pvecConnectionsData: std_list<[[ConnectionData]]((connectiondata))>)
3
func RequestURLs(cidTarget: uint32, pidTarget: uint32) -> (retval: bool, plstURLs: std_list<stationurl>)
4
func RegisterEx(vecMyURLs: std_list<stationurl>, hCustomData: any<[[Data]]((data)), string>) -> (retval: qresult, pidConnectionID: uint32, urlPublic: stationurl)

SimpleAuthentication

Protocols

Protocol IDName
16SimpleAuthenticationProtocol

SimpleAuthenticationProtocol

Method IDSignature
1
func Authenticate(strUserName: string) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
2
func LoginWithToken(strToken: string) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
3
func LoginWithTokenEx(strToken: string, oAnyData: any<[[Data]]((data)), string>) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
4
func Login(strUsername: string, strPassword: string) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
5
func LoginWithSubAccount(loginData: any<[[Data]]((data)), string>) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
6
func Register(vecMyURLs: std_list<stationurl>) -> (retval: qresult, pidConnectionID: uint32, urlPublic: stationurl)
7
func RegisterEx(vecMyURLs: std_list<stationurl>, hCustomData: any<[[Data]]((data)), string>) -> (retval: qresult, pidConnectionID: uint32, urlPublic: stationurl)
8
func LoginWithTokenCafe(strNintendoToken: string) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)
9
func LoginWithTokenCafeEx(strNintendoToken: string, oAnyData: any<[[Data]]((data)), string>) -> (retval: qresult, pidPrincipal: uint32, pConnectionData: [[RVConnectionData]]((rvconnectiondata)), strReturnMsg: string)

UserAccountManagementService

Protocols

UserAccountManagementProtocol

Method IDSignature
1
func LookupSceNpIds(pids: std_list<uint32>) -> (npids: std_map<uint32, qBuffer>)
2
func LookupPrincipalIDs(firstPartyIds: std_list<string>, platformId: uint32) -> (pids: std_map<string, uint32>)
3
func LookupFirstPartyIds(pids: std_list<uint32>, platformId: uint32) -> (firstPartyIds: std_map<uint32, string>)
4
func UserHasPlayed(FirstPartyIds: std_list<string>, platformId: uint32) -> (UserPresence: std_map<string, bool>)
5
func IsUserPlaying(firstPartyIds: std_list<string>, platformId: uint32) -> (UserPresence: std_map<string, bool>)
6
func updateSonyAccountInfo(ticketData: qBuffer, ticketSize: uint32) -> ()
7
func LookupUsernames(pids: std_list<uint32>, platformId: uint32) -> (UserNames: std_map<uint32, string>)

PlayerStatsService

Protocols

Protocol IDName
55PlayerStatsProtocol

PlayerStatsProtocol

Method IDSignature
1
func WriteStats(playerStatUpdates: qlist<[[PlayerStatUpdate]]((playerstatupdate))>) -> ()
2
func ReadStatsByPlayers(playerPIDs: qlist<uint32>, queries: qlist<[[StatboardQuery]]((statboardquery))>) -> (results: qlist<[[StatboardResult]]((statboardresult))>)
3
func ReadLeaderboardsNearPlayer(playerPID: uint32, count: uint32, queries: qlist<[[LeaderboardQuery]]((leaderboardquery))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
4
func ReadLeaderboardsByRank(startingRank: uint32, count: uint32, queries: qlist<[[LeaderboardQuery]]((leaderboardquery))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
5
func ReadLeaderboardsByPlayers(playerPIDs: qlist<uint32>, queries: qlist<[[LeaderboardQuery]]((leaderboardquery))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
6
func ReadStatboardHistory(queries: qlist<[[StatboardHistoryQuery]]((statboardhistoryquery))>) -> (results: qlist<[[StatboardResult]]((statboardresult))>)
7
func ReadLeaderboardHistory(queries: qlist<[[LeaderboardHistoryQuery]]((leaderboardhistoryquery))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
8
func ReadStatboardHistoryAggregated(queries: qlist<[[StatboardHistoryAggregatedQuery]]((statboardhistoryaggregatedquery))>) -> (results: qlist<[[StatboardResult]]((statboardresult))>)
9
func GetStatboardNextPurgeDate(boardID: uint32, resetFrequency: uint32) -> (purgeDate: datetime)
10
func ReadLeaderboardsNearPlayer2(playerPID: uint32, count: uint32, queries: qlist<[[LeaderboardQuery2]]((leaderboardquery2))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
11
func ReadLeaderboardsByRank2(startingRank: uint32, count: uint32, queries: qlist<[[LeaderboardQuery2]]((leaderboardquery2))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
12
func ReadLeaderboardsByPlayers2(queries: qlist<[[LeaderboardQuery2]]((leaderboardquery2))>) -> (results: qlist<[[LeaderboardResult]]((leaderboardresult))>)
13
func ReadPopulationStats(queries: qlist<[[PopulationStatQuery]]((populationstatquery))>) -> (results: qlist<[[PopulationStatResult]]((populationstatresult))>)

TrackingService

Protocols

Protocol IDName
?TrackingProtocol3

TrackingProtocol3

Method IDSignature
1
func SendTag(trackingID: uint32, tag: string, attributes: string, deltaTime: uint32) -> ()
2
func SendTagAndUpdateUserInfo(trackingID: uint32, tag: string, attributes: string, deltaTime: uint32, userID: string) -> ()
3
func SendUserInfo(deltaTime: uint32) -> (trackingID: uint32)
4
func GetConfiguration() -> (tags: std_list<string>)
5
func SendTags(tagData: std_list<[[TrackingTag]]((trackingtag))>) -> ()

GameSessionService

Protocols

Protocol IDName
42GameSessionProtocol

GameSessionProtocol

Method IDSignature
1
func CreateSession(gameSession: [[GameSession]]((gamesession))) -> (gameSessionKey: [[GameSessionKey]]((gamesessionkey)))
2
func UpdateSession(gameSessionUpdate: [[GameSessionUpdate]]((gamesessionupdate))) -> ()
3
func DeleteSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> ()
4
func MigrateSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> (gameSessionKeyMigrated: [[GameSessionKey]]((gamesessionkey)))
5
func LeaveSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> ()
6
func GetSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> (searchResult: [[GameSessionSearchResult]]((gamesessionsearchresult)))
7
func SearchSessions(gameSessionQuery: [[GameSessionQuery]]((gamesessionquery))) -> (searchResults: qlist<[[GameSessionSearchResult]]((gamesessionsearchresult))>)
8
func AddParticipants(gameSessionKey: [[GameSessionKey]]((gamesessionkey)), publicParticipantIDs: qlist<uint32>, privateParticipantIDs: qlist<uint32>) -> ()
9
func RemoveParticipants(gameSessionKey: [[GameSessionKey]]((gamesessionkey)), participantIDs: qlist<uint32>) -> ()
10
func GetParticipantCount(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> (count: uint32)
11
func GetParticipants(gameSessionKey: [[GameSessionKey]]((gamesessionkey)), resultRange: [[ResultRange]]((resultrange))) -> (participants: qlist<[[GameSessionParticipant]]((gamesessionparticipant))>)
12
func SendInvitation(invitation: [[GameSessionInvitation]]((gamesessioninvitation))) -> ()
13
func GetInvitationReceivedCount(gameSessionTypeID: uint32) -> (count: uint32)
14
func GetInvitationsReceived(gameSessionTypeID: uint32, resultRange: [[ResultRange]]((resultrange))) -> (invitations: qlist<[[GameSessionInvitationReceived]]((gamesessioninvitationreceived))>)
15
func GetInvitationSentCount(gameSessionTypeID: uint32) -> (count: uint32)
16
func GetInvitationsSent(gameSessionTypeID: uint32, resultRange: [[ResultRange]]((resultrange))) -> (invitations: qlist<[[GameSessionInvitationSent]]((gamesessioninvitationsent))>)
17
func AcceptInvitation(gameSessionInvitation: [[GameSessionInvitationReceived]]((gamesessioninvitationreceived))) -> ()
18
func DeclineInvitation(gameSessionInvitation: [[GameSessionInvitationReceived]]((gamesessioninvitationreceived))) -> ()
19
func CancelInvitation(gameSessionInvitation: [[GameSessionInvitationSent]]((gamesessioninvitationsent))) -> ()
20
func SendTextMessage(gameSessionMessage: [[GameSessionMessage]]((gamesessionmessage))) -> ()
21
func RegisterURLs(stationURLs: qlist<stationurl>) -> ()
22
func JoinSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> ()
23
func AbandonSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> ()
24
func SearchSessionsWithParticipants(gameSessionTypeID: uint32, participantIDs: qlist<uint32>) -> (searchResults: qlist<[[GameSessionSearchWithParticipantsResult]]((gamesessionsearchwithparticipantsresult))>)
25
func GetSessions(gameSessionKeys: qlist<[[GameSessionKey]]((gamesessionkey))>) -> (searchResults: qlist<[[GameSessionSearchResult]]((gamesessionsearchresult))>)
26
func GetParticipantsURLs(gameSessionKey: [[GameSessionKey]]((gamesessionkey)), participantIDs: qlist<uint32>) -> (participants: qlist<[[GameSessionParticipant]]((gamesessionparticipant))>)
27
func MigrateSessionHost(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> ()
28
func SplitSession(gameSessionKey: [[GameSessionKey]]((gamesessionkey))) -> (gameSessionKeyMigrated: [[GameSessionKey]]((gamesessionkey)))
29
func SearchSocialSessions(gameSessionSocialQuery: [[GameSessionSocialQuery]]((gamesessionsocialquery))) -> (searchResults: qlist<[[GameSessionSearchWithParticipantsResult]]((gamesessionsearchwithparticipantsresult))>)
30
func ReportUnsuccessfulJoinSessions(unsuccessfulJoinSessions: qlist<[[GameSessionUnsuccessfulJoinSession]]((gamesessionunsuccessfuljoinsession))>) -> ()

LocalizationService

Protocols

Protocol IDName
39LocalizationProtocol

LocalizationProtocol

Method IDSignature
1
func GetLocaleCode() -> (localCode: string)
2
func SetLocaleCode(localCode: string) -> ()

FriendsService

Protocols

Protocol IDName
20FriendsProtocol

FriendsProtocol

Method IDSignature
1
func AddFriend(uiPlayer: uint32, uiDetails: uint32, strMessage: string) -> (retval: bool)
2
func AddFriendByName(strPlayerName: string, uiDetails: uint32, strMessage: string) -> (retval: bool)
3
func AddFriendWithDetails(uiPlayer: uint32, uiDetails: uint32, strMessage: string) -> (relationshipData: [[RelationshipData]]((relationshipdata)))
4
func AddFriendByNameWithDetails(strPlayerName: string, uiDetails: uint32, strMessage: string) -> (relationshipData: [[RelationshipData]]((relationshipdata)))
5
func AcceptFriendship(uiPlayer: uint32) -> (retval: bool)
6
func DeclineFriendship(uiPlayer: uint32) -> (retval: bool)
7
func BlackList(uiPlayer: uint32, uiDetails: uint32) -> (retval: bool)
8
func BlackListByName(strPlayerName: string, uiDetails: uint32) -> (retval: bool)
9
func ClearRelationship(uiPlayer: uint32) -> (retval: bool)
10
func UpdateDetails(uiPlayer: uint32, uiDetails: uint32) -> (retval: bool)
11
func GetList(byRelationship: byte, bReversed: bool) -> (lstFriendsList: std_list<uint32>)
12
func GetDetailedList(byRelationship: byte, bReversed: bool) -> (lstFriendsList: std_list<[[FriendData]]((frienddata))>)
13
func GetRelationships(resultRange: [[ResultRange]]((resultrange))) -> (uiTotalCount: uint32, lstRelationshipsList: std_list<[[RelationshipData]]((relationshipdata))>)

PrivilegesService

Protocols

Protocol IDName
35PrivilegesProtocol

PrivilegesProtocol

Method IDSignature
1
func GetPrivileges(localeCode: string) -> (privileges: std_map<uint32, [[Privilege]]((privilege))>)
2
func ActivateKey(uniqueKey: string, languageCode: string) -> (privilege: [[PrivilegeGroup]]((privilegegroup)))
3
func ActivateKeyWithExpectedPrivileges(uniqueKey: string, languageCode: string, expectedPrivilegeIDs: qlist<uint32>) -> (privilege: [[PrivilegeGroup]]((privilegegroup)))
4
func GetPrivilegeRemainDuration(privilegeID: uint32) -> (seconds: int32)
5
func GetExpiredPrivileges() -> (expiredPrivileges: qlist<[[PrivilegeEx]]((privilegeex))>)
6
func GetPrivilegesEx(localeCode: string) -> (privilegesEx: qlist<[[PrivilegeEx]]((privilegeex))>)

NATTraversal

Protocols

Protocol IDName
?NATTraversalProtocol

NATTraversalProtocol

Method IDSignature
1
func RequestProbeInitiation(urlTargetList: qlist<stationurl>) -> ()
2
func InitiateProbe(urlStationToProbe: stationurl) -> ()
3
func RequestProbeInitiationExt(urlTargetList: qlist<stationurl>, urlStationToProbe: stationurl) -> ()

UplayWinService

Protocols

Protocol IDName
49UplayWinProtocol

UplayWinProtocol

Method IDSignature
1
func GetActions(startRowIndex: int32, maximumRows: int32, sortExpression: string, cultureName: string, platformCode: string, gameCode: string) -> (actionList: qlist<[[UplayAction]]((uplayaction))>)
2
func GetActionsCompleted(startRowIndex: int32, maximumRows: int32, sortExpression: string, cultureName: string, platformCode: string, gameCode: string) -> (actionList: qlist<[[UplayAction]]((uplayaction))>)
3
func GetActionsCount(platformCode: string, gameCode: string) -> (actionsCount: int32)
4
func GetActionsCompletedCount(platformCode: string, gameCode: string) -> (actionsCount: int32)
5
func GetRewards(startRowIndex: int32, maximumRows: int32, sortExpression: string, cultureName: string, platformCode: string, gameCode: string) -> (rewardList: qlist<[[UplayReward]]((uplayreward))>)
6
func GetRewardsPurchased(startRowIndex: int32, maximumRows: int32, sortExpression: string, cultureName: string, platformCode: string, gameCode: string) -> (rewardList: qlist<[[UplayReward]]((uplayreward))>)
7
func UplayWelcome(cultureName: string, platformCode: string, gameCode: string) -> (actionList: qlist<[[UplayAction]]((uplayaction))>)
8
func SetActionCompleted(actionCode: string, cultureName: string, platformCode: string, gameCode: string) -> (unlockedAction: [[UplayAction]]((uplayaction)))
9
func SetActionsCompleted(actionCodeList: qlist<string>, cultureName: string, platformCode: string, gameCode: string) -> (actionList: qlist<[[UplayAction]]((uplayaction))>)
10
func GetUserToken() -> (token: string)
11
func GetVirtualCurrencyUserBalance(platformCode: string) -> (virtualCurrencyUserBalance: int32)
12
func GetSectionsByKey(cultureName: string, sectionKey: string, platformCode: string, gameCode: string) -> (sectionList: qlist<[[UplaySection]]((uplaysection))>)
13
func BuyReward(rewardCode: string, platformCode: string) -> (virtualCurrencyUserBalance: int32)

UbiAccountManagementService

Protocols

Protocol IDName
29UbiAccountManagementProtocol

UbiAccountManagementProtocol

Method IDSignature
1
func CreateAccount() -> (failedReasons: qvector<[[ValidationFailureReason]]((validationfailurereason))>)
2
func UpdateAccount() -> (failedReasons: qvector<[[ValidationFailureReason]]((validationfailurereason))>)
3
func GetAccount() -> (ubiAccount: [[UbiAccount]]((ubiaccount)), exists: bool)
4
func LinkAccount(ubiAccountUsername: string, ubiAccountPassword: string) -> ()
5
func GetTOS(countryCode: string, languageCode: string, htmlVersion: bool) -> (tos: [[TOS]]((tos)))
6
func ValidateUsername(username: string) -> (usernameValidation: [[UsernameValidation]]((usernamevalidation)))
7
func ValidatePassword(password: string, username: string) -> (failedReasons: qvector<[[ValidationFailureReason]]((validationfailurereason))>)
8
func ValidateEmail(email: string) -> (failedReasons: qvector<[[ValidationFailureReason]]((validationfailurereason))>)
9
func GetCountryList(languageCode: string) -> (countries: qvector<[[Country]]((country))>)
10
func ForgetPassword(usernameOrEmail: string) -> ()
11
func LookupPrincipalIds(ubiAccountIds: std_list<string>) -> (pids: std_map<string, uint32>)
12
func LookupUbiAccountIDsByPids(pids: std_list<uint32>) -> (ubiaccountIDs: std_map<uint32, string>)
13
func LookupUbiAccountIDsByUsernames(Usernames: std_list<string>) -> (UbiAccountIDs: std_map<string, string>)
14
func LookupUsernamesByUbiAccountIDs(UbiAccountIds: std_list<string>) -> (Usernames: std_map<string, string>)
15
func LookupUbiAccountIDsByUsernameSubString(UsernameSubString: string) -> (UbiAccountIDs: std_map<string, string>)
16
func UserHasPlayed(UbiAccountIDs: std_list<string>) -> (UserPresence: std_map<string, bool>)
17
func IsUserPlaying(UbiAccountIDs: std_list<string>) -> (UserPresence: std_map<string, bool>)
18
func LookupUbiAccountIDsByUsernamesGlobal(Usernames: std_list<string>) -> (UbiAccountIDs: std_map<string, string>)
19
func LookupUbiAccountIDsByEmailsGlobal(Emails: std_list<string>) -> (UbiAccountIDs: std_map<string, string>)
20
func LookupUsernamesByUbiAccountIDsGlobal(UbiAccountIds: std_list<string>) -> (Usernames: std_map<string, string>)
21
func GetTOSEx(countryCode: string, languageCode: string, htmlVersion: bool) -> (tosex: [[TOSEx]]((tosex)))
22
func HasAcceptedLatestTOS() -> (hasAccepted: bool, failedReasons: qvector<[[ValidationFailureReason]]((validationfailurereason))>)
23
func AcceptLatestTOS() -> (failedReasons: qvector<[[ValidationFailureReason]]((validationfailurereason))>)

UserStorageAdmin

Protocols

Protocol IDName
?UserStorageAdminProtocol

UserStorageAdminProtocol

Method IDSignature
1
func GetContentsToModerate(typeID: uint32, offset: uint32, size: uint32) -> (contents: qlist<[[UserContent]]((usercontent))>, totalResults: uint32)
2
func FlagContentAsVerified(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
3
func BanContent(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
4
func BanUser(pid: uint32, reason: string, banContents: bool, expireDate: datetime) -> ()
5
func BanUserFromContentType(typeID: uint32, pid: uint32, reason: string, banContents: bool, expireDate: datetime) -> ()
6
func UnbanUser(pid: uint32) -> ()
7
func UnbanUserFromContentType(typeID: uint32, pid: uint32) -> ()
8
func GetContentsToModerateWithThreshold(typeID: uint32, threshold: uint32, offset: uint32, size: uint32) -> (contents: qlist<[[UserContent]]((usercontent))>, totalResults: uint32)
9
func UpdateMetaData(contentKey: [[UserContentKey]]((usercontentkey)), properties: qlist<[[ContentProperty]]((contentproperty))>) -> ()
10
func UpdateContentDB(contentKey: [[UserContentKey]]((usercontentkey)), properties: qlist<[[ContentProperty]]((contentproperty))>, data: string) -> ()
11
func UpdateContentAndGetUploadInfo(contentKey: [[UserContentKey]]((usercontentkey)), properties: qlist<[[ContentProperty]]((contentproperty))>, size: uint32) -> (uploadInfo: [[UserContentURL]]((usercontenturl)), pendingID: uint64, headers: qvector<string>)
12
func DeleteContent(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
13
func BrowseContents(typeID: uint32, offset: uint32, size: uint32) -> (contents: qlist<[[AdminContent]]((admincontent))>, totalResults: uint32)
14
func IsUserbanned(typeID: uint32, pid: uint32) -> (banned: bool, reason: string)
15
func GetBannedUsers(typeID: uint32, offset: uint32, size: uint32) -> (bannedUsers: qlist<[[BannedUser]]((banneduser))>, totalBannedUsers: uint32)

UserStorage

Protocols

Protocol IDName
53UserStorageProtocol

UserStorageProtocol

Method IDSignature
1
func SearchContents(query: [[UserStorageQuery]]((userstoragequery))) -> (searchResults: qlist<[[UserContent]]((usercontent))>)
2
func SearchContentsWithTotal(query: [[UserStorageQuery]]((userstoragequery))) -> (searchResults: qlist<[[UserContent]]((usercontent))>, totalResults: uint32)
3
func DeleteContent(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
4
func SaveMetaData(properties: qlist<[[ContentProperty]]((contentproperty))>) -> ()
5
func SaveContentDB(properties: qlist<[[ContentProperty]]((contentproperty))>, data: buffer) -> ()
6
func SaveContentAndGetUploadInfo(properties: qlist<[[ContentProperty]]((contentproperty))>, size: uint32, contentKey: [[UserContentKey]]((usercontentkey))) -> (uploadInfo: [[UserContentURL]]((usercontenturl)), pendingID: uint64, headers: qvector<string>)
7
func UploadEnd(pendingID: uint64, result: bool) -> ()
8
func GetContentDB(contentKey: [[UserContentKey]]((usercontentkey))) -> (data: buffer)
9
func GetContentURL(contentKey: [[UserContentKey]]((usercontentkey))) -> (downloadInfo: [[UserContentURL]]((usercontenturl)))
10
func GetSlotCount(typeID: uint32) -> (slotCount: [[UserSlotCount]]((userslotcount)))
11
func GetMetaData(contentKey: [[UserContentKey]]((usercontentkey))) -> (content: [[UserContent]]((usercontent)))
12
func Like(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
13
func Unlike(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
14
func IsLiked(contentKey: [[UserContentKey]]((usercontentkey))) -> (liked: bool)
15
func GetFavourites(contentTypes: qlist<uint32>) -> (favourites: qlist<[[UserContent]]((usercontent))>)
16
func MakeFavourite(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
17
func RemoveFromFavourites(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
18
func ReportInappropriate(contentKey: [[UserContentKey]]((usercontentkey)), reason: string) -> ()
19
func IncrementPlayCount(contentKey: [[UserContentKey]]((usercontentkey))) -> ()
20
func UpdateCustomStat(contentKey: [[UserContentKey]]((usercontentkey)), statID: uint16, incValue: int64) -> ()
21
func GetOwnContents(typeID: uint32) -> (results: qlist<[[UserContent]]((usercontent))>)
22
func GetMostPopularTags(contentKey: [[UserContentKey]]((usercontentkey))) -> (tags: qlist<[[WeightedTag]]((weightedtag))>, totalNumberOfTaggings: uint32)
23
func GetTags(contentKey: [[UserContentKey]]((usercontentkey))) -> (tagIds: qlist<uint32>)
24
func TagContent(contentKey: [[UserContentKey]]((usercontentkey)), newTagIds: qlist<uint32>) -> ()
25
func SearchContentsByPlayers(pids: qlist<uint32>, query: [[UserStorageQuery]]((userstoragequery))) -> (searchResults: qlist<[[UserContent]]((usercontent))>)
26
func SearchContentsByPlayersWithTotal(pids: qlist<uint32>, query: [[UserStorageQuery]]((userstoragequery))) -> (searchResults: qlist<[[UserContent]]((usercontent))>, totalResults: uint32)

UbiAuthentication

Protocols

NewsService

Protocols

Protocol IDName
?NewsProtocol

NewsProtocol

Method IDSignature
1
func GetChannels(resultRange: [[ResultRange]]((resultrange))) -> (channels: qlist<[[NewsChannel]]((newschannel))>)
2
func GetChannelsByTypes(newsChannelTypes: qlist<string>, resultRange: [[ResultRange]]((resultrange))) -> (channels: qlist<[[NewsChannel]]((newschannel))>)
3
func GetSubscribableChannels(resultRange: [[ResultRange]]((resultrange))) -> (channels: qlist<[[NewsChannel]]((newschannel))>)
4
func GetChannelsByIDs(newsChannelIDs: qlist<uint32>) -> (channels: qlist<[[NewsChannel]]((newschannel))>)
5
func GetSubscribedChannels(resultRange: [[ResultRange]]((resultrange))) -> (channels: qlist<[[NewsChannel]]((newschannel))>)
6
func SubscribeChannel(newsChannelID: uint32) -> ()
7
func UnsubscribeChannel(newsChannelID: uint32) -> ()
8
func GetNewsHeaders(recipient: [[NewsRecipient]]((newsrecipient)), range: [[ResultRange]]((resultrange))) -> (newsHeaders: qlist<[[NewsHeader]]((newsheader))>)
9
func GetNewsMessages(newsMessageIDs: qlist<uint32>) -> (newsMessages: qlist<[[NewsMessage]]((newsmessage))>)
10
func GetNumberOfNews(recipient: [[NewsRecipient]]((newsrecipient))) -> (numberOfNews: uint32)
11
func GetChannelByType(newsChannelType: string) -> (channel: [[NewsChannel]]((newschannel)))
12
func GetNewsHeadersByType(newsChannelType: string, range: [[ResultRange]]((resultrange))) -> (newsHeaders: qlist<[[NewsHeader]]((newsheader))>)
13
func GetNewsMessagesByType(newsChannelType: string, range: [[ResultRange]]((resultrange))) -> (newsMessages: qlist<[[NewsMessage]]((newsmessage))>)