This repository has been archived by the owner on Nov 16, 2023. It is now read-only.
1802 Preview Release
Pre-release
Pre-release
Whats new
- Added support for the IL2CPP scripting backend, alongside the pre-existing .NET scripting backend support.
- Microsoft.Xbox.Services.*.CSharp now is now dependent on same C++ code used by the XSAPI WinRT projections to ensure consistency.
- Aligned Microsoft.Xbox.Services.*.CSharp API surface with XSAPI WinRT projections. This alignment may cause breaking changes if you called into the DLL directly. See below for a complete list of (potentially) breaking changes.
Breaking changes
As mentioned above, the API surface of Microsoft.Xbox.Services.*.CSharp has changed to align with XSAPI WinRT. These changes only impact you if you called into the DLL directly or modified our scripts. Below is a complete list of changes:
Social
- SocialManager - changed signature of two methods;
AddLocalUser
andCreateSocialUserGroupFromList
, added three new methods;UpdateSocialUserGroup
,DestroySocialUserGroup
, andSetRichPresencePollingStatus
- SocialEvent - added
EventArgs
property, changed type ofUsersAffected
propery, removedGroupAffected
property, removedException
propery and addedErrorCode
andErrorMessage
properties in its place - SocialManagerExtraDetailLevel - Changed names of some enum values
- SocialManagerPresenceRecord - new class
- SocialManagerPresenceTitleRecord - removed
State
,IsPrimaryPropery
, andType
properties - SocialUserGroupLoadedEventArgs - new class
- SocialUserGroupType - removed value
Unknown
- XboxSocialUser - changed type of
XboxUserId
property from ulong to string, renamedIsFollowingCaller
property toIsFollowingUser
, removed propertiesPresenceState
andPresenceDetails
and addedPresenceRecord
property in their place, removed methodIsUserPlayingTitle(ulong titleId)
- XboxSocialUserGroup - added
LocalUser
property, renamedPresenceFilter
toPresenceFilterOfGroup
, renamedRelationshipFilter
toRelationshipFilterOfGroup
, addedUsersTrackedBySocialUserGroup
property, removed methodGetUser(ulong userId)
and addedGetUsersFromXboxUserIds(IList<string> xboxUserIds)
in its place
Stats
- LeaderboardQuery - renamed
SkipResultsToRank
toSkipResultToRank
- LeaderboardResult - removed
NextQuery
propery and addedGetNextQuery()
method - LeaderboardRow - changed type of
Rank
propery - StatisticManager - renamed class from
StatsManager
toStatisticManager
, changed signature ofDoWork
method, renamedSetStatAsNumber
method toSetStatisticNumberData
, renamedSetStatAsInteger
method toSetStatisticIntegerData
, renamedSetStatAsString
toSetStatisticStringData
, changed name and signature ofGetStat()
method toGetStatistic()
, changed name and signature ofGetStatNames()
method toGetStatisticNames(), changed name of
DeleteStat()to
DeleteStatistic(), changed signature of
GetLeaderboardmethod, added
GetSocialLeaderboardMethod` - LeaderboardResultEventArgs - new class
- StatisticDataType - renamed class from
StatValueType
toStatisticDataType
, addedUndefined
enum value - StatisticEvent - renamed class from
StatEvent
toStatisticEvent
- StatisticEventArgs - renamed class from
StatEventArgs
toStatisticEventArgs
- StatisticEventType - renamed enum from
StatEventType
toStatisticEventType
, renamedStatUpdateComplete
enum value toStatisticUpdateComplete
- StatisticValue - renamed class from
StatValue
toStatisticValue
, removedValue
property, renamedType
property toDataType
, removedAsNumber()
method and addedAsNumber
property, removedAsInteger()
method and addedAsInteger
property, removedAsString()
method and addedAsString
property
Title Storage
- TitleStorageQuota - added
XboxUserId
andServiceConfigurationId
properties
Privacy
- PermissionCheckResult - renamed
Reasons
property toDenyReasons
User
- SignInCompletedEventArgs - changed type of
User
property - SignOutCompletedEventArgs - changed type of
User
property - GetTokenAndSignatureResult - renamed class from
TokenAndSignatureResult
toGetTokenAndSignatureResult
, removedReserved
andTokenRequestResultStatus
properties
App Config
- XboxLiveAppConfiguration - renamed
Instance
toSingletonInstance
, renamedPrimaryServiceConfigId
toServiceConfigurationId
, removed thePublisherID
,PublisherDisplayName
,PackageIdentityName
,DisplayName
,AppId
,ProductFamilyName
,EnvironmentPrefix
,UseFirstPartyToken
, andXboxLiveCreatorsTitle
properties, removedGetEndPointForService
method
Deprecated services
- ProfileService - deprecated service; functionality can be achieved using social manager
- LeaderboardService - deprecated service; functionality can be achieved using stats manager
Known Issues
XboxLiveSettings
class has been renamed toXboxLiveContextSettings
and is temporarily non functional.