Sync Manager

The Sync Manager plugin is designed to link and unlink additional authentication methods into one user account, while also extending profile information and optionally adding or removing optional exclusive data from each authentication platform or service.


The Sync Manager plugin supports linking and unlinking various authentication methods, including company email address, username and password, Android login, iOS login, social connects including Facebook and Google Play, and custom identifications including custom cryptographic code.


For your users to be able to access your account through multiple authentication methods, use the Sync Manager plugin in the PlayFab Master Collection.

PlayFab API v2.png

Introduction

Step 1.png

The Construct Master Collection supports the full and easy integration of the PlayFab service for both Construct 3 and Construct 2.


Please click here to learn more about PlayFab.

Sync Methods


The Sync Manager plugin manages the linking of additional authentication methods into an existing account. In this way, you can add or remove authentication methods into the same account, this is called binding or unbinding an account. However, make sure to create an account to link first through the Authentication plugin, you can do this by choosing any authentication method available. Unique authentication credentials will pass for new account registration, if set. We recommend using quick authentication methods like Android Login and iOS Login for mobile, and Custom ID login for web and desktops applications. This way the player can seamlessly play your game without interruption and they can just optionally secure their account later on through the Sync Manager plugin.

Similar to initially authenticating for a new account, through the Authentication plugin. The Sync Manager also optionally allows the user account to receive 3rd party service information of the newly linked account from the new authentication method. For example, Facebook and Google Play optionally providing the account holder's name, profile picture, friends list, leaderboard scores and other profile information.

PlayFab keeps a record of all the linked authentication methods of an account, including the original registration authentication method. The data can be retrieved from the Account Info and Player Manager plugin.

By default there are 6 authentication methods to sync to with:

  • Company - uses an email, username and password authentication. This is an authentication system where you can use the server allocation for your own company title.

  • Android - uses the Android device's UUID (Universally Unique Identifier) for authentication.

  • Mobile Info - this addon is required to obtain the mobile device's UUID.

  • iOS - uses the iOS device's UUID (Universally Unique Identifier) for authentication.

  • Mobile Info - this addon is required to obtain the mobile device's UUID.

  • Facebook - uses Facebook for authentication. This requires an access token to access the Facebook servers.

  • Mobile Facebook - this addon is required to use either the Android Facebook SDK or iOS Facebook SDK. This is where the authentication is implemented and then an Access Token is manually passed into the Authentication plugin.

  • Web Facebook - this addon is required to use the Web Facebook SDK. This is where the authentication is implemented and then an Access Token is manually passed into the Authentication plugin.

  • Google Play - uses Google Sign-In for authentication. This requires a ServerAuthCode​ to access the Google servers.

  • Google Sign-In - this addon is required to use the Android Google SDK or iOS Google SDK. This is where the authentication is implemented and then a "ServerAuthCode" is manually passed into the Sync Manager plugin.

  • Cryptography - also known as the Custom ID. This is a customized identification you can assign for each user as an authentication method. It is named cryptography due to its flexibility of being assigned with any string. This gives you freedom on how you want to implement authentication for your game.


The synced accounts of players can be viewed in realtime in the players overview in the PlayFab console.


We are continuously working in adding more in the future. Please note that 3rd party porting services can easily and freely add more as well.


If you require an authentication method not available in the list, please contact support.



Editor Features


Here are some of the features in the Construct editor:

  • All platforms support, including web, mobile and desktop.

  • Construct 3

  • Construct 2

  • Native mobile integration

  • Construct 3 mobile build service

  • Construct 3 desktop build service

  • Android Studio

  • Xcode

  • Cordova CLI

 
 

How to use?

It is easy to use the User Data plugin, you will only need to follow the steps below.

  1. Set up the PlayFab API plugin, please click to visit the documentation. This includes creating a PlayFab account, studio and title.

  2. Set up the Authentication plugin, please click to visit the documentation.

  3. Finally, you can now use the Sync Manager object, and include more PlayFab addons for more features.

 
 

Documentation

There is currently nothing to show, we will add more in the future.

 

Actions, Conditions & Expressions

Actions

Actions
Actions

The actions for the PlayFab API plugin.

press to zoom
Actions
Actions

The actions for the PlayFab API plugin.

press to zoom
1/1

The following actions groups:

  • General

  • PlayFab API

  • Logout - Forget all credentials and any previous authentications are logged out.

  • Set Title Id - Set the Unique identifier for the Application Title.

  • This is found on your PlayFab Console.

  • You can set this on the Properties Bar.


  • Call API Method - Call a Client API method from PlayFab.

  • Method - The method key from the PlayFab Client API documentation.

  • Data (JSON) - The request data to pass with the api method call, in JSON string.

  • Custom Data (JSON) - The custom data to pass with the api request, in JSON string.


Conditions

The following conditions groups:

  • General

  • PlayFab API

  • Initialization

Conditions
Conditions

The conditions for the PlayFab API plugin.

press to zoom
Conditions
Conditions

The conditions for the PlayFab API plugin.

press to zoom
1/1
  • Is Logged In - Condition to check if the current user has authenticated to enable user-based PlayFab API features.

  • Is Initialized - Condition to check if the API is already loaded and available.

  • To be safe, check this initially when the application first starts before starting the PlayFab service.​

  • You only have to check for this once, usually when your application starts.


  • On Call API Response - Trigger fires if a Call API Method succeeded with a response from the PlayFab server.

  • On Call API Error - Trigger fires if a Call API Method received an error from the PlayFab server.

Expressions

Expressions
Expressions

The expressions for the PlayFab API plugin.

press to zoom
Expressions
Expressions

The expressions for the PlayFab API plugin.

press to zoom
1/1

The following expressions groups:

  • General

  • PlayFab API

  • GetTitleID- Return the title id declared in the plugin properties.

  • Response- Return the response data from the recent On Call API Response or On Call API Error, in JSON string.

Object   Properties

Plugin Properties

press to zoom

press to zoom
1/1

The following properties groups:

  • Configuration

  • The setup for the plugin while running.

  • Client Profile Data

  • Additional Profile Data to be included for each request. Match with the PlayFab Console > Client Profile Options.

  • Client Sensitive Data

  • Additional Sensitive Profile Data to be included in each request. Match with the PlayFab Console > Client Sensitive Profile Options.

Configuration - The setup for the plugin while running.

  • Title Id - Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

  • Debug Mode - If Enabled, the runtime will log errors across all plugin modules. This should be Disabled on production.

Client Profile Data - Additional Profile Data to be included for each request. Match with the PlayFab Console > Client Profile Options. ​

  • Avatar URL - Whether to show player's avatar URL.

  • Banned until Time - Whether to show the banned until time.

  • Campaign Attributions - Whether to show campaign attributions.

  • Creation Date - Whether to show the created date.

  • Last Login Time - Whether to show the last login time.

  • Locations - Whether to show player's locations.

  • Origination - Whether to show origination.

  • Statistics - Reserved for future development.

  • Tags - Whether to show tags.

  • Values to Date in USD - Whether to show the total value to date in usd.

  • Values to Date - Whether to show the values to date.

​​ Client Sensitive Data - Additional Sensitive Profile Data to be included in each request. Match with the PlayFab Console > Client Sensitive Profile Options.

  • Linked Accounts - Whether to show the linked accounts.

  • Push Notification - Whether to show push notification registrations.

  • Contact Email Address - Whether to show contact email addresses.

 
 

Showcase

There is currently nothing to show, we will add more in the future.

 

Game Projects 

Instructions Kit

Construct 3 Project
Construct 3 Project

press to zoom
Construct 2 Project
Construct 2 Project

press to zoom
Construct 3 Project
Construct 3 Project

press to zoom
1/2

Specifications

  • Instructions - The game project contains instructions and steps on how to use the addon and its features.

  • Action, Conditions and Expressions - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks on the recommended ways of using the addon.

Supporters

Only