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

Classes
enum	com.hive.Promotion.PromotionViewResultType
	Promotion view event types. More...

enum	com.hive.Promotion.PromotionViewType
	Types of Promotion view. More...

enum	com.hive.Promotion.PromotionCustomType
	Types of Promotion CustomView. More...

enum	com.hive.Promotion.PromotionBadgeTarget
	Information on which promotional badge is displayed If NOTICE, it should indicate the badge related to the notice. More...

enum	com.hive.Promotion.OfferwallState
	Information of Offerwall(free charging station) button. More...

class	com.hive.Promotion.PromotionViewInfo
	Information of Promotion webview (Information to customize your promotion Webview UI) More...

class	com.hive.Promotion.PromotionBadge
	Badge information to inform users that new promotions are registered. More...

class	com.hive.Promotion.PromotionBanner
	Banner information for a specific promotion. More...

class	com.hive.Promotion.AppInvitationData
	Promotion reward information (When showOfferwall () is called, it sends a reward request and displays Offerwall on the screen after receiving a response.) More...

class	com.hive.Promotion.AppInvitationCampaign
	Campaign information for invite Campaigns are data that specifies the conditions for rewarding invites. More...

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

Functions
static void	com.hive.Promotion.showPromotion (PromotionViewType promotionType, Boolean isForced, PromotionViewListener listener)
	Shows banner such as new event of game or introduce new game. More...

static void	com.hive.Promotion.showCustomContents (PromotionCustomType promotionCustomType, String contentsKey, PromotionViewListener listener)
	Show custom Webview to use external content. More...

static OfferwallState	com.hive.Promotion.getOfferwallState ()
	Returns whether the button is available to invoke an offerwall (free recharging station) within the game. More...

static void	com.hive.Promotion.showOfferwall (PromotionViewListener listener)
	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...

static void	com.hive.Promotion.showNativeReview ()
	Show review popup Positive ratings and reviews of game users will affect other users' use of the game. More...

static void	com.hive.Promotion.showExit (PromotionViewListener listener)
	Show exit popup (Android only) Expose exit popup which include a button called "More games" to lead users to download a new HIVE game. More...

static void	com.hive.Promotion.getViewInfo (PromotionCustomType promotionCustomType, String content_key, PromotionViewInfoListener listener)
	Request HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI More...

static void	com.hive.Promotion.getBadgeInfo (PromotionBadgeInfoListener listener)
	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...

static void	com.hive.Promotion.getBannerInfo (PromotionCampaignType campaignType, PromotionBannerType bannerType, PromotionBannerInfoListener listener)
	Request banner information Request banner information for a specific promotion. More...

static void	com.hive.Promotion.getAppInvitationData (AppInvitationDataListener listener)
	Request user invite information User acquisition information is provided to attract more users in the game. More...

static void	com.hive.Promotion.showUAShare (String inviteMessage, String inviteLink, PromotionShareListener listener)
	Show dialog to share UA url via SNS. More...

static void	com.hive.Promotion.setAdditionalInfo (String 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. More...

void	com.hive.Promotion.PromotionViewListener.onPromotionView (ResultAPI result, PromotionViewResultType promotionEventType)
	Promotion View API Result. More...

void	com.hive.Promotion.PromotionViewInfoListener.onReceiveInfo (ResultAPI result, ArrayList< PromotionViewInfo > viewInfo)
	Returns HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI. More...

void	com.hive.Promotion.PromotionBadgeInfoListener.onReceiveInfo (ResultAPI result, ArrayList< PromotionBadge > badgeInfoList)
	Returns HIVE Promotion badge information. More...

void	com.hive.Promotion.PromotionBannerInfoListener.onReceiveInfo (ResultAPI result, ArrayList< PromotionBanner > bannerInfoList)
	Returns HIVE Promotion banner information. More...

void	com.hive.Promotion.AppInvitationDataListener.onAppInvitationData (ResultAPI result, AppInvitationData appInvitationData)
	Return information about request for user invite (UserAcquisition) More...

static ResultAPI	com.hive.Promotion.setEngagementReady (boolean bReady)
	It sets whether Engagement event handling is enabled. More...

static void	com.hive.Promotion.setEngagementListener (EngagementListener listener)
	It register the Engagement listener. More...

void	com.hive.Promotion.EngagementListener.onEngagement (ResultAPI result, EngagementEventType engagementEventType, EngagementEventState engagementEventState, JSONObject param)
	An event listener for the SDK to engage clients in certain conditions. More...

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)

Function Documentation

§ getAppInvitationData()

static void com.hive.Promotion.getAppInvitationData ( AppInvitationDataListener listener )

static

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

listener API call result.

§ getBadgeInfo()

static void com.hive.Promotion.getBadgeInfo ( PromotionBadgeInfoListener listener )

static

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

listener API call result listener

§ getBannerInfo()

static void com.hive.Promotion.getBannerInfo	(	PromotionCampaignType	campaignType,
		PromotionBannerType	bannerType,
		PromotionBannerInfoListener	listener
	)

static

Request banner information
Request banner information for a specific promotion.

Used to retrieve banner information from the game server.

Parameters

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

§ getOfferwallState()

static OfferwallState com.hive.Promotion.getOfferwallState ( )

static

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

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.

§ getViewInfo()

static void com.hive.Promotion.getViewInfo	(	PromotionCustomType	promotionCustomType,
		String	content_key,
		PromotionViewInfoListener	listener
	)

static

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

Parameters

listener API call result listener

§ onAppInvitationData()

void com.hive.Promotion.AppInvitationDataListener.onAppInvitationData	(	ResultAPI	result,
		AppInvitationData	appInvitationData
	)

Return information about request for user invite (UserAcquisition)

Parameters

result	API call result
appInvitationData	User invite information.

§ onEngagement()

void com.hive.Promotion.EngagementListener.onEngagement	(	ResultAPI	result,
		EngagementEventType	engagementEventType,
		EngagementEventState	engagementEventState,
		JSONObject	param
	)

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

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

Parameters

result	Result of API call
engagementEventType	Event type
engagementEventState	Event status
param	Event information

§ onPromotionView()

void com.hive.Promotion.PromotionViewListener.onPromotionView	(	ResultAPI	result,
		PromotionViewResultType	promotionEventType
	)

Promotion View API Result.

Parameters

result	API call result
promotionEventType	Promotion event type

§ onReceiveInfo() [1/3]

void com.hive.Promotion.PromotionViewInfoListener.onReceiveInfo	(	ResultAPI	result,
		ArrayList< PromotionViewInfo >	viewInfo
	)

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
viewInfo	HIVE Promotion Webview information

§ onReceiveInfo() [2/3]

void com.hive.Promotion.PromotionBadgeInfoListener.onReceiveInfo	(	ResultAPI	result,
		ArrayList< PromotionBadge >	badgeInfoList
	)

Returns HIVE Promotion badge information.

Parameters

result	API call result
badgeInfoList	HIVE Promotion badge information

§ onReceiveInfo() [3/3]

void com.hive.Promotion.PromotionBannerInfoListener.onReceiveInfo	(	ResultAPI	result,
		ArrayList< PromotionBanner >	bannerInfoList
	)

Returns HIVE Promotion banner information.

Parameters

result	API call result
badgeInfoList	HIVE Promotion banner information

§ setAdditionalInfo()

static void com.hive.Promotion.setAdditionalInfo ( String additionalInfo )

static

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

§ setEngagementListener()

static void com.hive.Promotion.setEngagementListener ( EngagementListener listener )

static

It register the Engagement listener.

Parameters

listener

§ setEngagementReady()

static ResultAPI com.hive.Promotion.setEngagementReady ( boolean bReady )

static

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

bReady Whether Engagement events can be processed.

Returns: Whether the API call was successful.

§ showCustomContents()

static void com.hive.Promotion.showCustomContents	(	PromotionCustomType	promotionCustomType,
		String	contentsKey,
		PromotionViewListener	listener
	)

static

Show custom Webview to use external content.

Parameters

promotionCustomType	PromotionCustomType Type
contentsKey	ID of the custom web page set in the back office.
listener	API call result listener

§ showExit()

static void com.hive.Promotion.showExit ( PromotionViewListener listener )

static

Show exit popup (Android only)
Expose exit popup which include a button called "More games" to lead users to download a new HIVE game.

Parameters

listener API call result listener

§ showNativeReview()

static void com.hive.Promotion.showNativeReview ( )

static

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

Added in HIVE SDK 4.10.0

§ showOfferwall()

static void com.hive.Promotion.showOfferwall ( PromotionViewListener listener )

static

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.

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

listener API call result listener

§ showPromotion()

static void com.hive.Promotion.showPromotion	(	PromotionViewType	promotionType,
		Boolean	isForced,
		PromotionViewListener	listener
	)

static

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

Parameters

promotionType Promotion View type

isForced

If ture, it only works when promotionType 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.

listener API call result listener

§ showUAShare()

static void com.hive.Promotion.showUAShare	(	String	inviteMessage,
		String	inviteLink,
		PromotionShareListener	listener
	)

static

Show dialog to share UA url via SNS.

Parameters

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

HIVE SDK for Android

Classes

Functions

Detailed Description

Function Documentation

§ getAppInvitationData()

§ getBadgeInfo()

§ getBannerInfo()

§ getOfferwallState()

§ getViewInfo()

§ onAppInvitationData()

§ onEngagement()

§ onPromotionView()

§ onReceiveInfo() [1/3]

§ onReceiveInfo() [2/3]

§ onReceiveInfo() [3/3]

§ setAdditionalInfo()

§ setEngagementListener()

§ setEngagementReady()

§ showCustomContents()

§ showExit()

§ showNativeReview()

§ showOfferwall()

§ showPromotion()

§ showUAShare()