BiosPrivacyService Class Reference

BiosPrivacyService is used to query privacy permissions for a target user/s. More...

Private Member Functions
proto native EBiosError	GetPermissionsAsync (array< string > uid_list, array< EBiosPrivacyPermission > permission_list)
	Query for privacy permissions.
proto native EBiosError	GetPrivilegeAsync (EBiosPrivacyPrivilege privilege, bool try_resolution)
	Query for privileges.
void	OnPermissions (BiosPrivacyUidResultArray result_list, EBiosError error)
	Async callback for GetPermissionsAsync.
void	OnPrivilege (EBiosPrivacyPrivilege privilege, EBiosError error)
	Async callback for GetPrivilegeAsync.

Detailed Description

BiosPrivacyService is used to query privacy permissions for a target user/s.

Member Function Documentation

GetPermissionsAsync()

proto native EBiosError GetPermissionsAsync ( array< string >  uid_list, array< EBiosPrivacyPermission >  permission_list  )

private

Query for privacy permissions.

The async result is returned in the OnPermissions callback. Expected errors: BAD_PARAMETER - if atleast one of the permissions is not supported on the current platform, or atleast one of the input arrays is NULL.

Parameters

uid_list	list of target user Uid's for which to query privacy permissions.
permission_list	list of requested permissions for each target user.

Returns

EBiosError indicating if the async operation is pending.

Referenced by OnlineServices::LoadPermissions().

GetPrivilegeAsync()

proto native EBiosError GetPrivilegeAsync ( EBiosPrivacyPrivilege  privilege, bool  try_resolution  )

private

Query for privileges.

The async result is returned in the OnPrivilege callback. Expected errors: BAD_PARAMETER - if atleast one of the privileges is not supported on the current platform, PURCHASE_REQUIRED, BANNED, NOT_ALLOWED - the privilege is granted,

Parameters

privilege	the requested privilege.
tryResolution	Xbox: show system GUI with error msg and attempts to resolve it if possible.

Returns

EBiosError indicating if the async operation is pending.

Referenced by OnlineServices::LoadMPPrivilege(), and OnlineServices::LoadVoicePrivilege().

OnPermissions()

void OnPermissions ( BiosPrivacyUidResultArray  result_list, EBiosError  error  )

inlineprivate

Async callback for GetPermissionsAsync.

Parameters

result_list	list of results for each requested user. NULL if failed.
error	error indicating success or fail of the async operation.

References OnlineServices::OnPermissionsAsync(), and Print().

OnPrivilege()

void OnPrivilege ( EBiosPrivacyPrivilege  privilege, EBiosError  error  )

inlineprivate

Async callback for GetPrivilegeAsync.

Parameters

privilege	the requested privilege.
error	error indicating success or fail of the async operation.

References OnlineServices::OnLoadMPPrivilege(), and OnlineServices::OnLoadVoicePrivilege().

---

The documentation for this class was generated from the following file:

• P:/scripts/3_Game/Services/BiosPrivacyService.c