Event handler

@objc var delegate: ShopLiveSDKDelegate? { get set }

@objc public protocol ShopLiveSDKDelegate: AnyObject {
    @objc func handleNavigation(with url: URL)
    @objc func handleChangeCampaignStatus(status: String)
    @objc optional func handleChangedPlayerStatus(status: String)
    @objc func handleCampaignInfo(campaignInfo: [String : Any])

    @objc func onSetUserName(_ payload: [String : Any])

    @objc func handleCommand(_ command: String, with payload: Any?)
    @objc func handleReceivedCommand(_ command: String, with payload: Any?)

    @objc func handleError(code: String, message: String)

    @objc optional func handleDownloadCoupon(with couponId: String, result: @escaping (ShopLiveCouponResult) -> Void)
    @objc optional func handleCustomAction(with id: String, type: String, payload: Any?, result: @escaping (ShopLiveCustomActionResult) -> Void)
    @objc optional func playerPanGesture(state: UIGestureRecognizer.State, position: CGPoint)
    @objc optional func log(name: String, feature: ShopLiveLog.Feature, campaign: String, payload: [String: Any])

}

class MainViewController: UIViewController {
    ...
    override func viewDidLoad() {
        super.viewDidLoad()

        // delegate와 현재 클래스를 연결합니다.
        ShopLive.delegate = self

    }
    ...
}

// delegate를 연결할 클래스는 ShopLiveSDKDelegate Protocol을 구현합니다. 
extension MainViewController: ShopLiveSDKDelegate {
    func handleNavigation(with url: URL) {
        print("handleNavigation \(url)")
    }
    ...
}

handleNavigation(with url: URL)

extension MainViewController: ShopLiveSDKDelegate {
    func handleNavigation(with url: URL) {
        print("handleNavigation \(url)")

        UIApplication.shared.open(url, options: [:], completionHandler: nil)
    }
    ...
}

@objc func handleChangeCampaignStatus(status: String)

Sample code

extension MainViewController: ShopLiveSDKDelegate {
    func handleChangeCampaignStatus(status: String) {
        print("handleChangeCampaignStatus \(status)")

        switch status {
            case "READY", "ONAIR":
                break
            case "CLOSED":
                print("ended campaign")
                break
        }
    }
    ...
}

handleChangedPlayerStatus(status: String)

extension MainViewController: ShopLiveSDKDelegate {
    func handleChangedPlayerStatus(status: String) {
        print("handleChangedPlayerStatus \(status)")

        switch status {
            case "CREATED":
                break
            case "DESTROYED":
                break
        }
    }
    ...
}

handleCampaignInfo(campaignInfo: [String : Any])

extension MainViewController: ShopLiveSDKDelegate {
    func handleCampaignInfo(campaignInfo: [String : Any]) {

        campaignInfo.forEach { (key, value) in
            print("campaignInfo key: \(key)  value: \(value)")
        }

    }
    ...
}

extension MainViewController: ShopLiveSDKDelegate {
    func onSetUserName(_ payload: [String : Any]) {
        payload.forEach { (key, value) in
            print("onSetUserName key: \(key) value: \(value)")
        }
    }
    ...
}

extension MainViewController: ShopLiveSDKDelegate {
    func handleReceivedCommand(_ command: String, with payload: Any?) {
        switch command {
        case "LOGIN_REQUIRED":
            let alert = UIAlertController(title: command, message: "alert.login.required.description".localized(), preferredStyle: .alert)
            alert.addAction(.init(title: "alert.msg.ok".localized(), style: .default, handler: { _ in
                /*
                    1. 로그인 화면으로 이동
                    2. 로그인이 성공하면, 인증 사용자 계정을 연동하여 샵라이브플레이어를 다시 호출
                 */
                ShopLive.startPictureInPicture()
                let login = LoginViewController()
                login.delegate = self
                self.navigationController?.pushViewController(login, animated: true)
            }))
            alert.addAction(.init(title: "alert.msg.no".localized(), style: .default, handler: { _ in
                alert.dismiss(animated: true)
            }))
            ShopLive.viewController?.present(alert, animated: true, completion: nil)
            break
        case "CLICK_PRODUCT_CART":
          break
        default:
            break
        }
      
    }
    ...
}

@objc public enum ShopLiveViewTrackEvent : Int, CaseIterable {
    case viewWillDisAppear
    case viewDidDisAppear
    case pipWillAppear
    case pipDidAppear
    case fullScreenWillAppear
    case fullScreenDidAppear
    
    public var name : String {
        switch self {
        case .viewWillDisAppear:
            return "viewWillDisAppear"
        case .viewDidDisAppear:
            return "viewDidDisAppear"
        case .pipWillAppear:
            return "pipWillAppear"
        case .pipDidAppear:
            return "pipDidAppear"
        case .fullScreenWillAppear:
            return "fullScreenWillAppear"
        case .fullScreenDidAppear:
            return "fullScreenDidAppear"
        }
    }
}

extension MainViewController: ShopLiveSDKDelegate {
    func handleCommand(_ command: String, with payload: Any?) {
        print("handleCommand: \(command)  payload: \(payload)") 
    }
    ...
}

@objc public enum ShopLiveResultStatus: Int, CaseIterable {
    case SHOW // 쿠폰 다시 활성
    case HIDE // 쿠폰 사라짐
    case KEEP // 상태 유지

    public var name: String {
        switch self {
        case .SHOW:
            return "SHOW"
        case .HIDE:
            return "HIDE"
        case .KEEP:
            return "KEEP"
        }
    }
}

@objc public enum ShopLiveResultAlertType: Int, CaseIterable {
    case ALERT // 얼럿
    case TOAST // 토스트

    public var name: String {
        switch self {
        case .ALERT:
            return "ALERT"
        case .TOAST:
            return "TOAST"
        }
    }
}

@objc public class ShopLiveCouponResult: NSObject {
    var success: Bool         // 쿠폰 처리 성공/실패 여부
    var coupon: String = ""   // 쿠폰 ID
    var message: String?      // 알림 메시지
    var couponStatus: ShopLiveResultStatus // 완료 후 쿠폰 상태
    var alertType: ShopLiveResultAlertType // 알림 메시지 출력 타입

    public init(couponId: String, success: Bool, message: String?, status: ShopLiveResultStatus, alertType: ShopLiveResultAlertType) {
        self.coupon = couponId
        self.success = success
        self.message = message
        self.couponStatus = status
        self.alertType = alertType
    }
}

@objc public class ShopLiveCustomActionResult: NSObject {
    var success: Bool             // 커스텀 동작 처리 성공/실패
    var id: String = ""           // 커스텀 동작 ID   
    var message: String?          // 알림 메시지
    var couponStatus: ShopLiveResultStatus           // 완료 후 커스텀 동작 상태
    var alertType: ShopLiveResultAlertType           // 알림 메시지 출력 타입

    public init(id: String, success: Bool, message: String?, status: ShopLiveResultStatus, alertType: ShopLiveResultAlertType) {
        self.id = id
        self.success = success
        self.message = message
        self.couponStatus = status
        self.alertType = alertType
    }
}

handleDownloadCoupon(with couponId: String, result: @escaping (ShopLiveCouponResult) -> Void)

extension MainViewController: ShopLiveSDKDelegate {
    func handleDownloadCoupon(with couponId: String, result: @escaping (ShopLiveCouponResult) -> Void) {
        print("handleDownloadCoupon: \(couponId)")

        //쿠폰 처리 완료 시 호출 (처리 결과)
        // 성공
        let couponResult = ShopLiveCouponResult(couponId: couponId, success: true, message: "쿠폰 다운로드가 성공하였습니다.", status: .SHOW, alertType: .ALERT)
        // 실패
        let couponResult = ShopLiveCouponResult(couponId: couponId, success: false, message: "쿠폰 다운로드가 실패하였습니다.", status: .HIDE, alertType: .TOAST)
        result(couponResult)
    }
    ...

• 적용 가이드: 쿠폰 사용하기

handleCustomAction

handleCustomAction(with id: String, type: String, payload: Any?, result: @escaping (ShopLiveCustomActionResult) -> Void)

extension MainViewController: ShopLiveSDKDelegate {
    func handleCustomAction(with id: String, type: String, payload: Any?, result: @escaping (ShopLiveCustomActionResult) -> Void) {
        print("handleCustomAction \(id) \(type) \(payload.debugDescription)")

        // 팝업 처리가 완료되면 호출됨(처리 결과)
        // 성공
        let customActionResult = ShopLiveCustomActionResult(id: id, success: true, message: "Coupon download was successful.", status: .SHOW, alertType: .ALERT)

        // 실패
        let customActionResult = ShopLiveCustomActionResult(id: id, success: false, message: "Coupon download was failed.", status: .HIDE, alertType: .TOAST)

        result(customActionResult)
    }
    ...
}

handleError(code: String, message: String)

extension MainViewController: ShopLiveSDKDelegate {
    func handleError(code: String, message: String) {
        print("handleError \(code) \(message)")
    }
    ...
}

playerPanGesture(state: UIGestureRecognizer.State, position: CGPoint)

extension MainViewController: ShopLiveSDKDelegate {
	func playerPanGesture(state: UIGestureRecognizer.State, position: CGPoint) {
    	print("gesture state \(state) position \(position)")
	}
  ...
}

onEvent(name: String, feature: ShopLiveLog.Feature, campaign: String, payload: [String: Any])

@objc public class ShopLiveLog: NSObject {
    @objc public enum Feature: Int, CaseIterable {
        case CLICK, SHOW, ACTION
        
        public var name: String {
            switch self {
            case .CLICK:
                return "click"
            case .ACTION:
                return "action"
            case .SHOW:
                return "show"
            }
        }
        
        static func featureFrom(type: String) -> Feature? {
            return Feature.allCases.filter({$0.name == type}).first
        }
    }
    
    public var name: String
    public var campaign: String
    public var feature: Feature
    public var payload: [String: Any] = [:]
    
    public init(name: String, feature: Feature, campaign: String, payload: [String : Any]) {
        self.name = name
        self.feature = feature
        self.campaign = campaign
        self.payload = payload
    }
}

extension MainViewController: ShopLiveSDKDelegate {
    func onEvent(name: String, feature: ShopLiveLog.Feature, campaign: String, payload: [String : Any]) {
        let eventLog = ShopLiveLog(name: name, feature: feature, campaign: campaign, payload: payload)
        print("eventLog \(eventLog.name)")
    }
}