RewardsSDK
CloudCard的RewardsSDK
安装
CocoaPods是Cocoa项目的依赖管理器。有关使用和安装说明,请访问其网站。要使用CocoaPods将RewardsSDK集成到您的Xcode项目中,请在Podfile中指定它
pod 'RewardsSDK', :git => 'https://github.com/CloudCardInc/cc-rewards-ios-sdk.git'
使用
import RewardsSDK
RewardsManager.shared.initialize(origin: "XXXX",
cardholderId: "XXXX",
uiContext: self,
headerTitle: "XXXX",
userProfileName: "XXXX",
userProfileImage: URL,
summaryContent: "XXXX",
userCurrentLocation: CLLocation,
theme: RewardsSDKTheme,
environment: Environment)
参数
origin: String
origin参数需要字符串类型的值。它将由CloudCard提供以激活RewardsSDK。
cardholderId: String
cardholderId参数需要正在登录用户的应用程序中Cardholder ID,例如ch_xxxxxxxxx。
uiContext: viewController-Reference
uiContext参数将取当前视图引用以打开RewardsSDK。
headerTitle: String
headerTitle是可选的,可以用nil初始化函数。它支持字符串值以显示标题。
userProfileName: String
userProfileName参数是可选的。它可以取nil或用登录用户的字符串值。
userProfileImage: URL()
userProfileImage参数是可选的。它可以是nil或可以填写用户个人头像的URL。
summaryContent: String
summaryContent参数是可选的。它可以发送为nil或字符串值。
userCurrentLocation: CLLocation,
userCurrentLocation是可选参数,可以将nil初始化函数。它支持CLLocation以及用户坐标来显示附近的优惠。
theme: RewardSDKTheme()
theme参数支持自定义主题以设置RewardsSDK的外观和感觉。它是可选参数,可以发送nil初始化函数。
RewardsManager 额外功能
RewardsManager.shared.logoutUser()
从RewardsSDK注销当前登录用户。
RewardsManager.shared.dismissRewards { Bool in
}
从屏幕上关闭RewardsSDK。
RewardsManager.shared.addCustomCallbacks(callbacks: [String])
在RewardsSDK中注册自定义回调。
RewardsManagerDelegate
protocol RewardsManagerDelegate: NSObjectProtocol {
func errorOccured(error: String, reason: String)
func callbackDetected(name: String)
}
RewardsManager.shared.delegate = self
RewardsSDK在发生错误或接收到自定义回调时提供协议。
RewardsSDKTheme
let customTheme = RewardsSDKTheme()
customTheme.headerColor = Color
customTheme.primaryColor = Color
customTheme.interactiveColor = Color
customTheme.boldFontName = Font Name
customTheme.mediumFontName = Font Name
customTheme.regularFontName = Font Name
customTheme.lightFontName = Font Name
customTheme.logoStyle = RewardImageStyle
customTheme.profileImageStyle = RewardImageStyle
customTheme.brandDetailsHeaderStyle = RewardHeaderStyle
RewardsSDKTheme 参数
headerColor = .Color
primaryColor = .Color
interactiveColor = .Color
boldFontName = "Font Name in String"
mediumFontName = "Font Name in String"
regularFontName = "Font Name in String"
lightFontName = "Font Name in String"
logoStyle = .RewardsImageStyle
profileImageStyle = .RewardsImageStyle
brandDetailsHeaderStyle = .RewardsHeaderStyle
RewardImageStyle
enum RewardsImageStyle: Int {
case roundedRect
case circular
}
RewardHeaderStyle
enum RewardsHeaderStyle: Int {
case diagonal
case rectangular
}
环境
enum Environment :Int {
case SandBox
case Production
}