Getting Started
About Example
Launched in July 2010, Example is the first dedicated Android app store for the gaming industry and the premier destination for players discover, download and manage the best gaming apps. Example provides a trusted and secure branded app store that makes it easy for operators to distribute and promote their real money gaming apps, and for players to discover, download and play all of the games they love. Once players install Example and download their favorite real-money apps, management, updates and deposits are seamless. Example was founded to create the first Android ecosystem specifically for gaming, and Example’s executive team has deep roots in gaming and mobile industries. The company is privately held with offices in London, UK and Silicon Valley, USA.
Purpose
This Example Android SDK provides the necessary instructions, code examples, and tools enabling Partner developers to integrate Example technologies into their Android gaming apps.
Audience
This SDK is intended for use by Example Partner developers, engineers, and integrators who work with the Google Android APK application build process.
System architecture overview
The following figure shows a high-level view of Example's system architecture and work flow. For your reference, several key components described below are numbered in the figure.
Back-end services:
- 1 - Example Core System
- The Example Core System is the main controller managing user activities and provides the integration with the casino’s back-end servers.
- 2 - Example Transaction System
- The Example Transaction System is responsible for all payment-related activities, including management of payment processing interactions and user payment methods.
Client distributables:
- 3 - Example Store Application
- The Example Store Application (.apk) will be installed by consumers onto their Android devices. It allows a consumer to browse, search for, install, and update casino gaming applications. It requires the consumer to create a user account which is registered with the Example Core System, and provide a payment method which is registered with the Example Transaction System. The payment method is validated through the Bank System and stored in the Transaction System.
- 4 - Example Android SDK
- The Example Android SDK is integrated into your individual casino games. It provides the integration with the Example Store Application and payment services for your applications.
Figure: A high-level view of the Example system architecture
Integration using Android Studio
Example provides SDK integration instructions in this document collection for developers using the Google Android Studio IDE.
- Please see the SDK Integration page in this SDK.
- Download Google's Android Studio IDE
Android build reference
For your reference, extensive information regarding Google's Android build process can be found here:
SDK services
The Example Java Class along with its accompanying Interfaces and Methods provides service data and information for the SDK. Please see these documented in the Java Class Library page.
Android operating systems support
The Example Android SDK provides support for the following Android OS versions:
- Minimum supported version:
- Android 4.0 - Ice Cream Sandwich (API level 14)
- Reference: Android Codenames, Tags, and Build Numbers
User permissions
The Example Android SDK requires specific user permissions to operate effectively. Android applications should add the following permissions to their user permission model.
- Geolocation
- Example requires geolocation to provide location-relevant search results.
- Internet
- Required to open network sockets.
- Access Network State
- Required to access information about networks.
- Access Wifi State
- Required to access information about Wifi networks.
- Read Phone State
- Required to get Device specific details such as device id, OS, etc.
- Read External Storage (Read/Write)
- Required to read and write from an external storage.
- Access Fine Location
- Required to fetch to access precise location functionality.
- Access Coarse Location
- Required to access approximate location functionality.
- App History
- Retrieve the list of installed apps.
- Get Accounts
- Authenticate and synchronize Example account information between apps and devices.
- Wake Lock
- Required for certain synchronization events to be handled in the background.
Using the SDK's HTML5 documentation
In the HTML5 web version of this SDK, the following facilities are provided for your use and convenience. Note: These facilities are not available in the PDF print media version of the SDK's documentation.
- Tabbed keyboard navigation
-
The navigation bar at the top of each page, and hyperlinks through each page are fully accessible via your keyboard. This is important for users who employ assistive technologies (screen readers, etc.), and those who do not use pointer devices.
Using your keyboard:- Press the [Tab] key to advance through the navigation topic buttons.
- Press the [Enter/Return] key to open a topic page.
-
To reverse the sequence:
- Press and hold down the [Shift] key.
- Then press the [Tab] key multiple times until you return to the topic button you want. Press [Enter/Return] to open it.
- You can continue to use your keyboard to advance and return to all links as they appear throughout any page.
- TRANSLATE facility
-
Forty-eight human languages (and one Alien language for uber geeks - Klingon) are available for translation from English. Note: You must be online for the Translator to work.
-
To use the translation facility:
- Click [TRANSLATE].
- Click the downward-pointing arrow ( V ) in the select box.
- Click a language in the drop-down table.
- Translation will occur in-situ to the entire page except for any code samples.
- To view the original language of a translated sentence, hover your pointer over the sentence.
-
To use the translation facility:
- Editable code examples
- Most of the code examples in the SDK Integration page are editable.
-
- The edited code can be copied and pasted into a text editor or IDE of choice.
- Line numbering will not accompany the copied snippet.
- Pressing [Reset] in the lower-right corner of an edited code example will return the code to its original state.
- Search
-
A search facility local to the SDK documentation is provided on each page in the navigation bar.
-
Enter a minimum of three characters of a keyword into the search box and press [Enter/Return].
- For example, if you are searching for the word "parameter", enter "par" into the search box and press [Enter/Return].
- Search results consisting of pages that contain that word will appear on a new page titled "Search Engine Results Page (SERP)".
-
Enter a minimum of three characters of a keyword into the search box and press [Enter/Return].
- Responsive web design
- This Android SDK's web-based documentation is written in strict HTML5 format with unobtrusive CSS 2.1, CSS3, and JavaScript. It is fully responsive, web accessible, semantically appointed for Linked Data and Deep Linking, and can be viewed in web browser view ports for desktops, laptops, tablets, and smartphones.
- Print icon
- Each page has its own print shortcut icon. Click the print icon located in the upper-right side of any web page to open your browser's print facility.
- PDFs
- The APIs and the SDK have their own PDF Books. Also, individual documents listed in the Repository home page have their own PDF .