Gameball Developers Guide
v3.0
Ask or search…
K

Getting Started

Install the Gameball iOS SDK into your app
The Gameball SDK for iOS enables you to use the show Gameball player profile in your app, track app player events, integrate referrals and display Gameball's in-app push notifications.

Installation

Follow the below steps to start installing the iOS SDK to your app
1. Add Cocoapods to Your Project
If your project is using CocoaPods, skip to the next part of this article, Add Gameball Pod.
  • Open the terminal window
  • Navigate to the root folder of your Xcode project
  • Run the following command in terminal
$ pod init
  • Close Xcode if open then open your project’s newly created .xcworkspace
  • Your project is now using CocoaPods to install dependencies
2. Add Gameball Pod
  • Add the code below in your Podfile which was created by CocoaPods
source 'https://github.com/CocoaPods/Specs.git'
target 'YourAppName' do
use_frameworks!
pod 'Gameball',
End
  • Navigate to your project’s root folder in a terminal window
  • Run the command below in terminal
$ pod install
  • Gameball will install several Pods that it has as dependencies.
When the Pod command finishes execution, you will have Gameball installed and ready to use.
Gameball is also available through [Swift Package Manager]. To install it, simply search for 'Gameball' or add the repo URL:
https://github.com/gameballers/gameball-ios.git

Initialization

Import the SDK into the created pod, using CocoaPods, to setup the Gameball Widget in the best way for your use-case.
In order to use Gameball you must configure a GameballApp.
  • Import our pod to your viewController
import Gameball
  • Create a global GameballApp variable in your viewController to access anywhere within your viewController
var gameball: Gameball?
  • Then initialize it as the following:
gameball = Gameball(
apiKey: "YOUR_API_KEY", // The only required field
lang: "ar",
shop: "MyShop",
platform: "iOS",
completion: { [weak self] in // Completion block when SDK init is completed
guard let self = self else {return}
// You can enable showing profile, registering player, etc. see next section
}
)

Parameter
Required
Description
apiKey
Required
Client API key
lang
Optional
Your platform language preference to view Gameball Widget with. Note: The language provided should be as per configured languages in your account. If not provided the Gameball profile widget will be shown with your account default language.
Example: "en", "fr".
shop
Optional
Shopify store name with myshopify.com domain. Used if your app is a mobile app for a shopify store connected to Gameball
platform
Optional
Platform used, for example (shopify)
completion
Optional
Completion block that gets called when the initialization of the SDK is completed
You may also check the sample project here to view full implementation.