HIVE Promotion gives users who use the game the ability to effectively expose new news or events in the game. More...

Classes
class	HIVEPromotionBadge
	Badge information to inform users that new promotions are registered. More...

class	HIVEPromotionBanner
	Banner information for a specific promotion. More...

class	HIVEPromotionViewInfo
	Information of Promotion webview (Information to customize your promotion Webview UI) More...

class	HIVEAppInvitationData
	Invite information for UserAcquisition. More...

class	HIVEAppInvitationCampaign
	Campaign information for invite Campaigns are data that specifies the conditions for rewarding invite. More...

class	HIVEAppInvitationCampaignStage
	Campaign information for invitation Campaigns are data that specifies the conditions for rewarding invites. More...

class	HIVEPromotion
	HIVE Promotion provides you with the ability to effectively expose new news or events to the game user. More...

Typedefs
typedef void(^	HIVEPromotionViewHandler) (HIVEResultAPI *result, HIVEPromotionViewResultType type)
	Promotion View API Result. More...

typedef void(^	HIVEPromotionInfoHandler) (HIVEResultAPI result, NSArray< HIVEPromotionViewInfo > *viewInfos)
	Returns HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI. More...

typedef void(^	HIVEPromotionBadgeHandler) (HIVEResultAPI result, NSArray< HIVEPromotionBadge > *badgeInfos)
	Returns HIVE Promotion badge information. More...

typedef void(^	HIVEPromotionBannerInfoHandler) (HIVEResultAPI result, NSArray< HIVEPromotionBanner > *bannerInfos)
	HIVE Promotion banner information.

typedef void(^	HIVEPromotionShareHandler) (HIVEResultAPI *result)
	Returns HIVE UA Share information. More...

typedef void(^	HIVEAppInvitationDataHandler) (HIVEResultAPI result, HIVEAppInvitationData invitationData)
	Returns information about request for user invite (UserAcquisition) More...

typedef void(^	HIVEEngagementHandler) (HIVEResultAPI result, HIVEEngagementEventType engagementEventType, HIVEEngagementEventState engagementState, NSDictionary param)
	An event listener for the SDK to engage clients in certain conditions. More...

Enumerations
enum	HIVEPromotionViewResultType { kHIVEPromotionViewResultTypeOpen = 0, kHIVEPromotionViewResultTypeClose }
	Promotion view event types. More...

enum	HIVEPromotionViewType { kHIVEPromotionViewTypeBANNERLegacy = -1, kHIVEPromotionViewTypeBANNER = 0, kHIVEPromotionViewTypeNEWS, kHIVEPromotionViewTypeNOTICE }
	Types of Promotion view. More...

enum	HIVEPromotionCustomType { kHIVEPromotionCustomTypeVIEW = 0, kHIVEPromotionCustomTypeBOARD, kHIVEPromotionCustomTypeSPOT, kHIVEPromotionCustomTypeDIRECT }
	Types of Promotion CustomView. More...

enum	HIVEPromotionBadgeTarget { kHIVEPromotionBadgeTargetNEWS = 0, kHIVEPromotionBadgeTargetNOTICE, kHIVEPromotionBadgeTargetCUSTOMVIEW, kHIVEPromotionBadgeTargetCUSTOMBOARD }
	Information on which promotional badge is displayed If NOTICE, it should indicate the badge related to the notice. More...

Functions
typedef	NS_ENUM (NSUInteger, HIVEOfferwallState)
	Information of Offerwall(free charging station) button. More...

typedef	NS_ENUM (NSInteger, HIVEPromotionCampaignType)
	Campaign type selected before requesting rolling banner data. More...

typedef	NS_ENUM (NSInteger, HIVEPromotionBannerType)
	Banner type selected before requesting rolling banner data. More...

typedef	NS_ENUM (NSUInteger, HIVEEngagementEventType)
	Function type of UserEngagement. More...

typedef	NS_ENUM (NSUInteger, HIVEEngagementEventState)
	The status that HIVE SDK engages clients in certain conditions. More...

(void)	+ HIVEPromotion::showPromotion:isForced:handler:
	Shows banner such as new event of game or introduce new game. More...

(void)	+ HIVEPromotion::showCustomContents:contents:handler:
	Show custom Webview to use external content. More...

(HIVEOfferwallState)	+ HIVEPromotion::getOfferwallState
	Returns whether the button is available to invoke an offerwall (free recharging station) within the game. More...

(void)	+ HIVEPromotion::showOfferwall:
	Show Offerwall(Free recharging station) (Android only.) The Offerwall (free recharge station) is an advertising network between HIVE games, which enables existing HIVE users to use the new HIVE game. More...

(void)	+ HIVEPromotion::showNativeReview
	Show review popup Positive ratings and reviews of game users will affect other users' use of the game. More...

(void)	+ HIVEPromotion::getViewInfo:contents:handler:
	Request HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI More...

(void)	+ HIVEPromotion::getBadgeInfo:
	Request badge information The promotional badge is information that highlights the button UI of the game to inform the user that a new promotion has been registered. More...

(void)	+ HIVEPromotion::getBannerInfo:bannerType:handler:
	Request banner information Request banner information for a specific promotion. More...

(void)	+ HIVEPromotion::getAppInvitationData:
	Request user invite information User acquisition information is provided to attract more users in the game. More...

(void)	+ HIVEPromotion::showUAShare:inviteLink:handler:
	Show dialog to share UA url via SNS. More...

(void)	+ HIVEPromotion::setAdditionalInfo:
	You can set a string in JSON format when you want to expose a specific event page in the Promotion View or want to pass additional information to the Promotion Server. More...

(HIVEResultAPI *)	+ HIVEPromotion::setEngagementReady:
	It sets whether Engagement event handling is enabled. More...

(void)	+ HIVEPromotion::setEngagementHandler:
	Registers the Engagement listener. More...

(BOOL)	+ HIVEPromotion::processURI:
	Transmits Engagement Event URI to HIVE module. More...

Properties
HIVEPromotionBadgeTarget	HIVEPromotionBadge::target
	Target to mark badge For example, if NOTICE, you should mark the badge associated with the notice. More...

NSString *	HIVEPromotionBadge::contentsKey
	Promotion unique ID registered in the backoffice in case the target is custom contents.

NSString *	HIVEPromotionBadge::badgeType
	Types of badge (Can be "new" or "none")

NSString *	HIVEPromotionViewInfo::url
	Information to customize your promotion Webview UI. More...

NSString *	HIVEPromotionViewInfo::postString
	POST data required to load webview. If URLRequest has no data, the pages provided by HIVEPromotion are unavailable.

NSData *	HIVEAppInvitationData::qrcode
	QR Code image data with app invite information.

NSString *	HIVEAppInvitationData::inviteCommonLink
	Default invite link.

NSString *	HIVEAppInvitationData::inviteHivemsgLink
	Invite link for HIVE certified users.

NSString *	HIVEAppInvitationData::inviteFacebookLink
	Invite link for Facebook certified users.

NSString *	HIVEAppInvitationData::inviteMessage
	Invite message (HIVE SDK v4.11.4+)

NSArray< HIVEAppInvitationCampaign * > *	HIVEAppInvitationData::eachCampaigns
	List of campaigns that will be rewarded every time when a campaign is completed.

NSArray< HIVEAppInvitationCampaignStage * > *	HIVEAppInvitationData::stageCampaigns
	List of campaigns that will be rewarded when you reach the campaign completion goal of invites.

NSString *	HIVEAppInvitationData::originalJson
	가공되지 않은 원본 데이터

NSString *	HIVEAppInvitationCampaign::title
	Title.

NSString *	HIVEAppInvitationCampaign::desc
	Description.

NSString *	HIVEAppInvitationCampaign::imgURL
	Image URL.

NSDictionary *	HIVEAppInvitationCampaign::item
	Complete reward information ("key" depends on campaign settings)

NSInteger	HIVEAppInvitationCampaign::count
	Number of invitees who completed the campaign.

NSInteger	HIVEAppInvitationCampaign::limit
	Maximum number of user of campaigns.

NSInteger	HIVEAppInvitationCampaignStage::goalCount
	The number of player who complete the all stage.

NSInteger	HIVEAppInvitationCampaignStage::goalTotal
	The number of player required to complete the all stage to get rewards.

Detailed Description

HIVE Promotion gives users who use the game the ability to effectively expose new news or events in the game.

Promotion view (notice, event), reward (coupon, deep link), exit popup (Android), free charging station(Offerwall)

Typedef Documentation

§ HIVEAppInvitationDataHandler

typedef void(^ HIVEAppInvitationDataHandler) (HIVEResultAPI *result, HIVEAppInvitationData *invitationData)

Returns information about request for user invite (UserAcquisition)

Parameters

result	API call result
invitationData	User invite information.

§ HIVEEngagementHandler

typedef void(^ HIVEEngagementHandler) (HIVEResultAPI *result, HIVEEngagementEventType engagementEventType, HIVEEngagementEventState engagementState, NSDictionary *param)

An event listener for the SDK to engage clients in certain conditions.

The specific conditions are, for example, URL click on messages in push notification, in mobile message (SMS), or user actions in promotional view.

Parameters

result	API call result
engagementEventType	Event type
engagementState	Event status
param	Event information

§ HIVEPromotionBadgeHandler

typedef void(^ HIVEPromotionBadgeHandler) (HIVEResultAPI *result, NSArray< HIVEPromotionBadge * > *badgeInfos)

Returns HIVE Promotion badge information.

Parameters

result	API call result
badgeInfos	HIVE Promotion badge information

§ HIVEPromotionInfoHandler

typedef void(^ HIVEPromotionInfoHandler) (HIVEResultAPI *result, NSArray< HIVEPromotionViewInfo * > *viewInfos)

Returns HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI.

Parameters

result	API call result
viewInfos	HIVE Promotion Webview information

§ HIVEPromotionShareHandler

typedef void(^ HIVEPromotionShareHandler) (HIVEResultAPI *result)

Returns HIVE UA Share information.

result API call result

§ HIVEPromotionViewHandler

typedef void(^ HIVEPromotionViewHandler) (HIVEResultAPI *result, HIVEPromotionViewResultType type)

Promotion View API Result.

Parameters

result	API call result
type	Promotion event type

Enumeration Type Documentation

§ HIVEPromotionBadgeTarget

enum HIVEPromotionBadgeTarget

Information on which promotional badge is displayed
If NOTICE, it should indicate the badge related to the notice.

Enumerator
kHIVEPromotionBadgeTargetNEWS	The target to display News.
kHIVEPromotionBadgeTargetNOTICE	The target to display Notice.
kHIVEPromotionBadgeTargetCUSTOMVIEW	The target to display Custom view.
kHIVEPromotionBadgeTargetCUSTOMBOARD	The target to display Custom board.

§ HIVEPromotionCustomType

enum HIVEPromotionCustomType

Types of Promotion CustomView.

Enumerator
kHIVEPromotionCustomTypeVIEW	Customized View.
kHIVEPromotionCustomTypeBOARD	Customized Board.
kHIVEPromotionCustomTypeSPOT	Spot Banner.
kHIVEPromotionCustomTypeDIRECT	Direct Campaign Banner.

§ HIVEPromotionViewResultType

enum HIVEPromotionViewResultType

Promotion view event types.

Enumerator
kHIVEPromotionViewResultTypeOpen	When the Promotion View window opens.
kHIVEPromotionViewResultTypeClose	When the Promotion View window is closed.

§ HIVEPromotionViewType

enum HIVEPromotionViewType

Types of Promotion view.

Enumerator
kHIVEPromotionViewTypeBANNERLegacy	Full Banner.
kHIVEPromotionViewTypeBANNER	Full Banner.
kHIVEPromotionViewTypeNEWS	News.
kHIVEPromotionViewTypeNOTICE	Notice.

Function Documentation

§ getAppInvitationData:()

+ (void) getAppInvitationData: (HIVEAppInvitationDataHandler) handler

Request user invite information
User acquisition information is provided to attract more users in the game.

Data for user acquisition include QR Code, invite links, and campaigns.
A campaign is data that specifies the conditions for rewarding an invite.
The invite URL or QR code provides rewards to both the invited and invited users when the invited user achieves the conditions such as installing the game and achieving a certain level (condition and reward can be set in the back office).

Parameters

handler API call result.

§ getBadgeInfo:()

+ (void) getBadgeInfo: (HIVEPromotionBadgeHandler) handler

Request badge information
The promotional badge is information that highlights the button UI of the game to inform the user that a new promotion has been registered.

Parameters

handler API call result handler

§ getBannerInfo:bannerType:handler:()

+ (void) getBannerInfo:	(HIVEPromotionCampaignType)	campaignType
bannerType:	(HIVEPromotionBannerType)	bannerType
handler:	(HIVEPromotionBannerInfoHandler)	handler

Request banner information
Request banner information for a specific promotion.

Used to retrieve banner information from the game server.

Parameters

campaignType	"event", "notice"
handler	API call result listener

§ getOfferwallState()

+ (HIVEOfferwallState) getOfferwallState

Returns whether the button is available to invoke an offerwall (free recharging station) within the game.

게임내에서 무료 충전소를 노출하기 위한 버튼 UI 는 보여지거나 숨길 수 있도록 구성해야 한다.

The button UI for exposing free recharge stations within the game must be configured to be visible or hidden.

Returns: whether the button is available.

이 메서드는 게임내에서 오퍼월(무료 충전소) 을 호출 할 수 있는 버튼 노출 가능 여부를 반환한다.

Returns: 오퍼월(무료 충전소) 을 호출 할 수 있는 버튼 노출 가능 여부

§ getViewInfo:contents:handler:()

+ (void) getViewInfo:	(HIVEPromotionCustomType)	type
contents:	(NSString *)	key
handler:	(HIVEPromotionInfoHandler)	handler

Request HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI

Parameters

type
key
handler

§ NS_ENUM() [1/5]

typedef NS_ENUM	(	NSUInteger	,
		HIVEOfferwallState
	)

Information of Offerwall(free charging station) button.

Author: KyuJin Kim

< Offerwall Button can be exposed.

< Offerwall Button can not be exposed.

< Status unknown.

§ NS_ENUM() [2/5]

typedef NS_ENUM	(	NSInteger	,
		HIVEPromotionCampaignType
	)

Campaign type selected before requesting rolling banner data.

Author: Seokjin Yong

§ NS_ENUM() [3/5]

typedef NS_ENUM	(	NSInteger	,
		HIVEPromotionBannerType
	)

Banner type selected before requesting rolling banner data.

Author: Seokjin Yong

§ NS_ENUM() [4/5]

typedef NS_ENUM	(	NSUInteger	,
		HIVEEngagementEventType
	)

Function type of UserEngagement.

Added in HIVE SDK 4.5.0

< Notifying the start and the end of implementing Engagement.

< PromotionView handled by Engagement.

< OfferwallView handled by Engagement. If EventState is kHIVEEngagementStateEventEnd, the result of processing PromotionView is transmitted to ResultAPI and Param.

< Not Support Yet.

< Results for consumption of coupons processed by Engagement.

< Result callback of login process which is not opened by the user (client).

< Start to service social community so-called Cafe.

< Start to service 1:1 inquiry.

< Function to invite friends from social network services.

< Sending messages to social network servie users.

< Callback that delivers events unavailable to be handled by Engagement (in case the host is game).

< Callback when user starts to purchase an item.

< Callbacks when trying to buy items outside of the app or a callback that delivers item information when an item is purchased through interwork.

< Promotion CPA Link recevied. SDK completed to send promotion companion data.

§ NS_ENUM() [5/5]

typedef NS_ENUM	(	NSUInteger	,
		HIVEEngagementEventState
	)

The status that HIVE SDK engages clients in certain conditions.

Added in HIVE SDK 4.5.0

< Notifies the start of implementing Engagement.

< Notifies the termination of implementing Engagement.

< Notifies the start of other functions performed by Engagement.

< Notifies the termination of other functions performed by Engagement.

§ processURI:()

+ (BOOL) processURI: (NSURL *) URI

Transmits Engagement Event URI to HIVE module.

Added in HIVE SDK 4.4.0 Modified in HIVE SDK 4.5.0

Parameters

URI	URI to perform Engagement

§ setAdditionalInfo:()

+ (void) setAdditionalInfo: (NSString *) additionalInfo

You can set a string in JSON format when you want to expose a specific event page in the Promotion View or want to pass additional information to the Promotion Server.

(Required) Even a single server group without a server group should be properly put in the following example
ex)"addtionalInfo":"{"server":"0","character":"0"}"

Parameters

additionalInfo (Required) Additional information data in JSON format

§ setEngagementHandler:()

+ (void) setEngagementHandler: (HIVEEngagementHandler) engagementHandler

Registers the Engagement listener.

Parameters

engagementHandler HIVEEngagementHandler

§ setEngagementReady:()

+ (HIVEResultAPI *) setEngagementReady: (BOOL) isReady

It sets whether Engagement event handling is enabled.

(Such as when a DB is created in the game server) If you want to set it to true, it must be in a state that satisfies the condition of <after login & after registering the listener>, if you want to set it to false, you can always set it.

Parameters

isReady Whether Engagement events can be processed.

Returns: Whether the API call was successful.

§ showCustomContents:contents:handler:()

+ (void) showCustomContents:	(HIVEPromotionCustomType)	type
contents:	(NSString *)	key
handler:	(HIVEPromotionViewHandler)	handler

Show custom Webview to use external content.

Parameters

type	PromotionCustomType Type
key	ID of the custom web page set in the back office.
handler	API call result listener

§ showNativeReview()

+ (void) showNativeReview

Show review popup
Positive ratings and reviews of game users will affect other users' use of the game.

It is known that the number of user participation increases by 5 ~ 10 times when the review
Review popup on the device with iOS 10.3 and later is available to rate and write reviews in apps.

Since: 4.10.0

§ showOfferwall:()

+ (void) showOfferwall: (HIVEPromotionViewHandler) handler

Show Offerwall(Free recharging station) (Android only.)
The Offerwall (free recharge station) is an advertising network between HIVE games, which enables existing HIVE users to use the new HIVE game.

무료 충전소 화면 노출 무료 충전소는 HIVE 게임 간의 광고 네트워크로 기존 HIVE 유저들이 새로운 HIVE 게임을 이용할 수 있도록 유도하는 기능이다.

A list of the games that the user can download is exposed, and the game is downloaded and executed, and reward is provided in the game as the medium.

Parameters

handler API call result handler

유저가 다운로드 받을 수 있는 게임을 목록으로 노출하고 게임을 다운로드 받아 실행하면 매체가 되는 게임에서 보상이 제공된다.

Parameters

listener API 결과 통지

§ showPromotion:isForced:handler:()

+ (void) showPromotion:	(HIVEPromotionViewType)	type
isForced:	(BOOL)	isForced
handler:	(HIVEPromotionViewHandler)	handler

Shows banner such as new event of game or introduce new game.

Parameters

type Promotion View type

isForced

If ture, it only works when type is "notice" and "event"

                     and it ignore 'Not seeing it again for 24 hours'. 
                     (Note: Since 'Not seeing it again for 24 hours' does not apply, you should only use certain actions, such as viewing as a button action.)

                     If false or omitted, 'Not seeing it again for 24 hours' will operate normally.

handler API call result handler

§ showUAShare:inviteLink:handler:()

+ (void) showUAShare:	(NSString *)	inviteMessage
inviteLink:	(NSString *)	inviteLink
handler:	(HIVEPromotionShareHandler)	handler

Show dialog to share UA url via SNS.

Parameters

inviteMessage	UA invite message
inviteLink	UA invite link
handler	API call result listener

Properties

§ target

- (HIVEPromotionBadgeTarget) target

readnonatomicassign

Target to mark badge
For example, if NOTICE, you should mark the badge associated with the notice.

(Can be NEWS, NOTICE, CUSTOMVIEW, CUSTOMBOARD)

§ url

- (NSString*) url

readnonatomicstrong

Information to customize your promotion Webview UI.

The URL to be loaded by webview

HIVE SDK for iOS

Classes

Typedefs

Enumerations

Functions

Properties

Detailed Description

Typedef Documentation

§ HIVEAppInvitationDataHandler

§ HIVEEngagementHandler

§ HIVEPromotionBadgeHandler

§ HIVEPromotionInfoHandler

§ HIVEPromotionShareHandler

§ HIVEPromotionViewHandler

Enumeration Type Documentation

§ HIVEPromotionBadgeTarget

§ HIVEPromotionCustomType

§ HIVEPromotionViewResultType

§ HIVEPromotionViewType

Function Documentation

§ getAppInvitationData:()

§ getBadgeInfo:()

§ getBannerInfo:bannerType:handler:()

§ getOfferwallState()

§ getViewInfo:contents:handler:()

§ NS_ENUM() [1/5]

§ NS_ENUM() [2/5]

§ NS_ENUM() [3/5]

§ NS_ENUM() [4/5]

§ NS_ENUM() [5/5]

§ processURI:()

§ setAdditionalInfo:()

§ setEngagementHandler:()

§ setEngagementReady:()

§ showCustomContents:contents:handler:()

§ showNativeReview()

§ showOfferwall:()

§ showPromotion:isForced:handler:()

§ showUAShare:inviteLink:handler:()

Properties

§ target

§ url