@everymatrix/player-account-controller v1.29.7
Player Account Controller widget Documentation
About the Player Account Controller widget
Intro to the Player Account Controller widget
The Player Account Controller widget is a collection of web components designed and developed to offer easy installation and access for the user to his account page - the page where he can customize his experience on your site by setting his preferences.
The widget is agnostic about the framework, library or programming language your current product is built on, while at the same time offering ease of integration for developers, and a sleek gateway to your site for your users.
A progressive widget
We like to call our Player Account Controller widget a "progressive" one since it grows with you. If you just want a simple implementation our architecture and documentation will be there to help you achieve it in mere minutes.
If you are looking for a bigger implementation into a much more mature product the casino widget gives you a set of robust tools for using player sessions, customizing actions, customizing the UI, enabling or disabling widget features on demand and more.
A scalable widget
The Player Account Controller widget scales with you. Although the scalability is mainly accomplished by your main product (the one you integrate this widget into) and by your architecture we took all the necessary steps and precautions to ensure the uninterrupted functionality of this product.
A stateless widget
In the development of this widget we considered that the widget should not care about any kind of state a container product (the product this widget is integrated into) might have nor that the widget itself should have any kind of state management.
We took this decision in order to ensure maximum integration compatibility as well as infinite scalability. By not sharing or having a state our widgets can be used as a main widget (like the casino lobby) or as singular components wherever you want to place them.
For example here is a list of the components used in order to display the Player Account Controller widget:
- Player Account Menu
- Player Account Notifications
- Player Profile Info
- Player Change Password
These components can also be used on their own, and they still can communicate to each other even if they are structurally placed in separate parts of your application (they still need to be on the same page).
Pre-requisites needed
For the Widget to be able to work, the parent website needs to integrated with the EM platform.
Supported integrations:
- NorWAy Integration
- CE Integration
For further information on how to proceed with your current integration please contact your assigned Integration Manager.
Setup the widget on your website.
To install the latest version released for the widget, which will be automatically updated once a new release is made, add the following script tag, in the root page of your application.
The script can be added either in the or in the . We recommend adding it in the footer of the page for better performance of the entire website.
<script src="https://unpkg.com/@everymatrix/player-account-controller/dist/player-account-controller.js"></script>
For a specific version, the script tag looks like this:
<script src="https://unpkg.com/@everymatrix/player-account-controller@1.0.0/dist/player-account-controller.js"></script>
Usage
For the logged in
state, inside your page you need to add the webcomponent tag for the Player Account Controller Widget
. The page will be available after an postMessage of the type PlayerAccountMenuActive
is triggered.
<player-account-controller
endpoint="https://demo-api.stage.norway.everymatrix.com/v1"
lang="en"
cmsendpoint="https://wp-one-widgets.everymatrix.com/wp-json/wpone-rest/v1"
accountpath="/menu-locations/profile-menu"
notificationpath="/support_information"
playerid="3657535"
session="30154385-db0e-454f-8d00-44f83b67bf04"
customnotifications="#58586B,#2687F6,#D0046Cd"
></player-account-controller>
Full example below:
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>EM Widgets | Player Account Controller Widget Demo</title>
<script src="https://unpkg.com/@everymatrix/player-account-controller/dist/player-account-controller.js"></script>
</head>
<body>
<div class="container">
<player-account-controller
endpoint="https://demo-api.stage.norway.everymatrix.com/v1"
lang="en"
cmsendpoint="https://wp-one-widgets.everymatrix.com/wp-json/wpone-rest/v1"
accountpath="/menu-locations/profile-menu"
notificationpath="/support_information"
playerid="3657535"
session="30154385-db0e-454f-8d00-44f83b67bf04"
customnotifications="#58586B,#2687F6,#D0046Cd"
></player-account-controller>
</div>
</body>
</html>
Both the aaccountpath
and notificationpath
are used together with the cmsendpoint, through concatenation, in order to obtain the necessary data for the player account menu and support information area.
The customnotifications
is a string data that contains the background colors used for the support information boxes, making it easy for the client to customize them.
PLEASE NOTE: The given example is a fully working HTML page and demo credentials are used for
endpoint
field. For development and productions purposes you will need to use your own provided credentials.
Communication between widgets
Type | Message data | Comment |
---|---|---|
PlayerAccountMenuActive | no extra data sent | triggers the displaying of the Player Account Controller |
UpdatePlayerInfo | {} | sends an object with the updated field values from Player Profile Info to Player Account Controller |
ChangePassword | userCurrentPassword, userNewPassword | toggles show/hide of the Change Password Form |
ReturnToMenu | no extra data sent | for mobile use only: returns user to the Player Account Menu |
PasswordChangedSuccessfully | no extra data sent | if user has successfully changed his password, switch to action feedback screen |
AccountMenuDetails | accountMenuInfo | sends the account menu data from Player Account Controller to Player Account Menu |
NotificationsDetails | notificationsInfo | sends the support information data from Player Account Controller to Player Account Notifications |
ProfileDetailsData | profileDetails | sends the player form data from Player Account Controller to Player Profile Info |
LogOut | no extra data sent | logs out user |
ChangeAccountPage | page | changes the displayed content based on the Player Account Menu navigation |
API Reference
Parameter | Mandatory | Comment |
---|---|---|
endpoint | yes | NorWAy endpoint |
lang | yes | Language of the website |
session | no | EM SessionID of the logged in user |
opsession | no | Operator SessionID of the logged in user |
playerid | no | EM UserID of the logged in user |
cmsendpoit | yes | The CMS endpoint from which the data is configured |
aaccountpath | yes | CMS path for obtaining the menu items for the Player Account Menu |
notificationpath | yes | CMS path for obtaining the Support Information |
customnotifications | no | Custom color codes used as backgrounds for the Support Information boxes |
Releases
Release Version | Value | Scope | Status | Completed Date |
---|---|---|---|---|
0.0.42 | Initial release | - | DONE | 04 Aug 2021 |
2 days ago
12 days ago
18 days ago
24 days ago
26 days ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
5 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
10 months ago
7 months ago
10 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
12 months ago
1 year ago
12 months ago
12 months ago
1 year ago
1 year ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago