This repository was 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;
AddLocalUserandCreateSocialUserGroupFromList, added three new methods;UpdateSocialUserGroup,DestroySocialUserGroup, andSetRichPresencePollingStatus - SocialEvent - added
EventArgsproperty, changed type ofUsersAffectedpropery, removedGroupAffectedproperty, removedExceptionpropery and addedErrorCodeandErrorMessageproperties in its place - SocialManagerExtraDetailLevel - Changed names of some enum values
- SocialManagerPresenceRecord - new class
- SocialManagerPresenceTitleRecord - removed
State,IsPrimaryPropery, andTypeproperties - SocialUserGroupLoadedEventArgs - new class
- SocialUserGroupType - removed value
Unknown - XboxSocialUser - changed type of
XboxUserIdproperty from ulong to string, renamedIsFollowingCallerproperty toIsFollowingUser, removed propertiesPresenceStateandPresenceDetailsand addedPresenceRecordproperty in their place, removed methodIsUserPlayingTitle(ulong titleId) - XboxSocialUserGroup - added
LocalUserproperty, renamedPresenceFiltertoPresenceFilterOfGroup, renamedRelationshipFiltertoRelationshipFilterOfGroup, addedUsersTrackedBySocialUserGroupproperty, removed methodGetUser(ulong userId)and addedGetUsersFromXboxUserIds(IList<string> xboxUserIds)in its place
Stats
- LeaderboardQuery - renamed
SkipResultsToRanktoSkipResultToRank - LeaderboardResult - removed
NextQuerypropery and addedGetNextQuery()method - LeaderboardRow - changed type of
Rankpropery - StatisticManager - renamed class from
StatsManagertoStatisticManager, changed signature ofDoWorkmethod, renamedSetStatAsNumbermethod toSetStatisticNumberData, renamedSetStatAsIntegermethod toSetStatisticIntegerData, renamedSetStatAsStringtoSetStatisticStringData, changed name and signature ofGetStat()method toGetStatistic(), changed name and signature ofGetStatNames()method toGetStatisticNames(), changed name ofDeleteStat()toDeleteStatistic(), changed signature ofGetLeaderboardmethod, addedGetSocialLeaderboardMethod` - LeaderboardResultEventArgs - new class
- StatisticDataType - renamed class from
StatValueTypetoStatisticDataType, addedUndefinedenum value - StatisticEvent - renamed class from
StatEventtoStatisticEvent - StatisticEventArgs - renamed class from
StatEventArgstoStatisticEventArgs - StatisticEventType - renamed enum from
StatEventTypetoStatisticEventType, renamedStatUpdateCompleteenum value toStatisticUpdateComplete - StatisticValue - renamed class from
StatValuetoStatisticValue, removedValueproperty, renamedTypeproperty toDataType, removedAsNumber()method and addedAsNumberproperty, removedAsInteger()method and addedAsIntegerproperty, removedAsString()method and addedAsStringproperty
Title Storage
- TitleStorageQuota - added
XboxUserIdandServiceConfigurationIdproperties
Privacy
- PermissionCheckResult - renamed
Reasonsproperty toDenyReasons
User
- SignInCompletedEventArgs - changed type of
Userproperty - SignOutCompletedEventArgs - changed type of
Userproperty - GetTokenAndSignatureResult - renamed class from
TokenAndSignatureResulttoGetTokenAndSignatureResult, removedReservedandTokenRequestResultStatusproperties
App Config
- XboxLiveAppConfiguration - renamed
InstancetoSingletonInstance, renamedPrimaryServiceConfigIdtoServiceConfigurationId, removed thePublisherID,PublisherDisplayName,PackageIdentityName,DisplayName,AppId,ProductFamilyName,EnvironmentPrefix,UseFirstPartyToken, andXboxLiveCreatorsTitleproperties, removedGetEndPointForServicemethod
Deprecated services
- ProfileService - deprecated service; functionality can be achieved using social manager
- LeaderboardService - deprecated service; functionality can be achieved using stats manager
Known Issues
XboxLiveSettingsclass has been renamed toXboxLiveContextSettingsand is temporarily non functional.