Changelog

All notable changes to the package will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Due to package verification, the latest version below is the unpublished version and the date is meaningless. however, it has to be formatted properly to pass verification tests.

[0.0.14-preview] - 2020-09-25

Fixed

  • Add missing documentation for various enums, classes and methods.

[0.0.13-preview] - 2020-09-22

Added

  • Leaderboards
    • GetBoardDefinitionRequest - Get the leaderboard definition state.
    • RecordScoreRequest - Record score, including attaching large data if required
    • GetRankingRequest - Read the current leaderboard results
    • GetLargeDataRequest - Download any large data attached to a leaderboard entry.
  • Large data restrictions:
    • Only one of the upload strategies is currently supported. Large data is uploaded after the score is sent.
    • The internal buffers need to be large enough to handle the size of the data both being uploaded and downloaded.
    • Use the Main.Initialize method to set the size of the buffers. By default they are set to 2mb

Changed

  • Main.Initialize - Added parameters to set the internal read and write buffers used to marshal data to the native .prx.
    • These are both defaulted to 2mb.

[0.0.12-preview] - 2020-09-14

Added

  • Support for user sign in/out notifications (OnSignedInNotification, StartSignedStateCallbackRequest and StopSignedStateCallbackRequest)
  • Support for PSN reachability notifications (OnReachabilityNotification, StartReachabilityStateCallbackRequest and StopReachabilityStateCallbackRequest)

[0.0.11-preview] - 2020-09-07

Added

  • Matches
    • CreateMatchRequest - Create a match.
    • GetMatchDetailRequest - Retrieve the details and status of a match.
    • UpdateMatchStatusRequest - Change the match status to playing, on-hold or cancelled.
    • JoinMatchRequest - Have a player join a match.
    • LeaveMatchRequest - Have a player leave a match.
    • ReportResultsRequest - Submit the results of a match and match stats.
    • UpdateMatchDetailRequest - Update the details of the match, including submitting interim results and stats.
  • Player review dialog
    • OpenPlayerReviewDialogRequest - Display player review dialog.
  • Message dialog
    • OpenMsgDialogRequest - Display the common message dialog, including support for showing the PSN Communication Restriction message

Fixed

  • Sample
    • Display publishing settings path when using Set Publish Settings For PS5 editor script in Unity 2020.1 or above

[0.0.10-preview] - 2020-08-28

Changed

  • GetBlockingUsersRequest - Added support to return NextOffset, PreviousOffset and TotalItemCount

[0.0.9-preview] - 2020-07-31

Added

  • Game Sessions
    • CreateGameSessionRequest - Create a game session
    • LeaveGameSessionRequest - A user leaves the game session
    • JoinGameSessionRequest - A user joins an existing game session as a player or spectator
    • GetGameSessionsRequest - Get info about a game session
    • SetGameSessionPropertiesRequest - Change some of the parameters of a game session
    • Added PlayerNotification and GameNotification type for user based notifications for player and game sessions.
    • SetGameSessionMemberSystemPropertiesRequest - Set custom data for a game session member
    • SendGameSessionMessageRequest - Send player session message
    • GetJoinedGameSessionsByUserRequest - Get a list of game sessions belonging to the user
    • DeleteGameSessionRequest - Delete a game session.
  • Commerce Dialog
    • OpenJoinPremiumDialogRequest = Support to open and close Join premium dialog

Changed

  • Renamed NotificationPlayerSessionData to NotificationSessionData as both player and game session notification share the same json notification structure.
  • Changed Notification struct to class so it can contain player and game notification types

[0.0.8-preview] - 2020-07-02

Added

  • Player Sessions
    • Merge session changes in the RetrievedSessionData class, received from calling the GetPlayerSessionsRequest, into the PlayerSession object. This will allow the current state of the player session to be cached locally.
    • GetPlayerSessionInvitationsRequest used to retrieve invitations for a user.
    • ChangePlayerSessionLeaderRequest used change the leader of a player session
    • AddPlayerSessionJoinableSpecifiedUsersRequest - Add list of join-able specified users to a session.
    • DeletePlayerSessionJoinableSpecifiedUsersRequest - Delete list of join-able specified users from a session.
    • SetPlayerSessionMemberSystemPropertiesRequest - Set member system properties for a player session (CustomData1)
    • SendPlayerSessionMessageRequest - Sends a message to a list of user.
    • GetJoinedPlayerSessionsByUserRequest - Obtain a list of Player Sessions in which a user is participating
    • SetPlayerSessionPropertiesRequest - Update Player Session information
    • SwapPlayerSessionMemberRequest - Swap session member between between player and spectator.
    • Create session now supports setting both CustomData1 and CustomData2 during creation.
  • WebApi Notifications
    • Added user event callback, UserSessionEventHandler, called when non-guaranteed user events are received.
  • PS4 Cross-gen
    • Added PS4 Cross-gen .prx plugins to package
    • Supports Authentication, Player Sessions, Game Intent, Online Safety, WebApi Notifications

Changed

  • Updated the RetrievedSessionData class to include all the data returned from the GetPlayerSessionsRequest
  • Improved error messages in Sample app. Each async requests output errors if they occur.
  • Updated many request class to use List<> objects instead of Arrays to reduce memory garbage.
  • Reduced number of delegates to just one for a PlayerSession and another for User events. (OnSessionUpdated, OnUserEvent)

[0.0.7-preview] - 2020-06-29

Changed

  • Removed from WebApiNotifications:
    • CreateFilterRequest and RemoveFilterRequest
    • RegisterUserCallbackRequest and UnregisterUserCallbackRequest
  • Added to WebApiNotifications:
    • CreatePushEventRequest and DeletePushEventRequest
    • WebApiPushEvent -> Filters are now included inside the a new Push event object
    • Push events can be configured to be order-guaranteed
  • WebApiFilterSet renamed to WebApiFilters

Added

  • PlayerSession:

    • Create session, setting max players, max spectators, allow swapping, join and invite restrictions, leader privileges and localised session name
    • Leave session
    • User can join an already existing session as a player or spectator, including join a session created by another local user.
    • Retrieve player session settings and data
    • Send session invites
    • Merge player and spectator info retrieved from WebApi notifications into the local PlayerSession object.
    • Added callbacks to PlayerSession when WebApiNotifications are received.
      • OnSessionMemberUpdated is used when member joins, leaves or changes role. The data from the notification is automatically updated in the PlayerSession
      • OnSessionUpdated is used when a session parameter is changed. The notification doesn't contain any data about the change therefore RetrievedSessionData should be used to retrieve the data.
      • SetExternalEventCallback is used to return raw notification data.

  • WebApiFilters

    • Supports ServiceName and ServiceLabel parameters
    • Now reference counted when registered with a WebApiPushEvent
    • Can only be unregistered when its reference count is 0

[0.0.6-preview] - 2020-05-20

Added

  • Feature Gating provides methods to check if a user is allowed to access premium features or notify the system when a premium feature is being used
    • CheckPremiumRequest
  • Authentication system provides a feature to obtain the authorization code required by the application server to access user information on the PSN server
    • GetAuthorizationCodeRequest
    • GetIdTokenRequest

[0.0.5-preview] - 2020-04-01

Changed

  • PostEventRequest can now return the estimated size of the sent event.
  • Renamed TrophyService to TrophySystem
  • Renamed GameIntentService to GameIntentSystem
  • Renamed RegisterUserFiltersRequest to RegisterUserCallbackRequest
  • Renamed UnregisterUserFiltersRequest to UnregisterUserCallbackRequest

Added

  • StartSystemRequest and StopSystemRequest added to UDS.
  • Can now set the UDS memory pool size using StartSystemRequest.
  • GetMemoryStatsRequest returns memory stats for UDS.
  • Included support for Float64 (double), Bool and Binary property types for UDS EventProperty and EventPropertyArray
  • Retrieve Game Icons, Group Icons, Trophy Icons and Reward Icons from the Trophy system.
  • ShowTrophyListRequest will display the Trophy list system dialog.
  • Online Safety features supported - GetCommunicationRestrictionStatusRequest and FilterProfanityRequest added.

[0.0.4-preview] - 2020-03-05

Changed

  • Updated to use SDK 0.95
  • Move Trophy support from separate package into this one.
  • Split system into additional namespaces to group functionality and produce better documentation

Added

  • Added HTML documentation to HTML~ directory in package root.

[0.0.3-preview] - 2019-12-13

Changed

  • Updated to work with SDK 0.9
  • Renamed Pzazz to PS5

Added

  • WebApi Notifications
    • Create Filters and notifications for webapi events.
  • User presence
    • Return online/offline basic presence for user(s)

[0.0.2-preview] - 2019-10-31

Changed

  • Moved location of C++ source files and update VS projects

[0.0.1-preview] - 2019-10-17

Fixed

  • Initial Version

Changed

  • Initial Version

Added

  • Asynchronous Requests
    • Provides a way to call the API using asynchronous calls.
  • User Management
    • User can be registered and unregistered with the underlying native services. This is required for all other API's to work on a system level.
  • Universal Data System
    • Supports sending events and creating Event data, include custom event data structures.
  • Game Intent
    • Supports a callback when a user selects an Activity.