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

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

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

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

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

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

class	FHiveAppInvitationData
	Invite information for UserAcquisition. More...

class	FHiveAppInvitationSenderInfo
	First sender's userInfo who sent UA share invitation. More...

Enumerations
enum class	EHivePromotionType { EHivePromotionType::BANNER_LEGACY = -1 , EHivePromotionType::BANNER , EHivePromotionType::NEWS , EHivePromotionType::NOTICE }
	Types of Promotion view. More...

enum class	EHivePromotionEventType { EHivePromotionEventType::OPEN , EHivePromotionEventType::CLOSE , EHivePromotionEventType::START_PLAYBACK , EHivePromotionEventType::FINISH_PLAYBACK , EHivePromotionEventType::EXIT , GOBACK }
	Promotion view event types. More...

enum class	EHivePromotionCustomType { EHivePromotionCustomType::VIEW , EHivePromotionCustomType::BOARD , EHivePromotionCustomType::SPOT , EHivePromotionCustomType::DIRECT }
	Types of Promotion CustomView. More...

enum class	EHiveOfferwallState { EHiveOfferwallState::ENABLED , EHiveOfferwallState::DISABLED , EHiveOfferwallState::UNKNOWN }
	Information of Offerwall(free charging station) button. More...

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

enum class	EHivePromotionCampaignType
	Campaign type selected before requesting rolling banner data.

enum class	EHivePromotionBannerType
	Banner type selected before requesting rolling banner data.

enum class	EHiveEngagementEventType
	UserEngagement 기능 타입

enum class	EHiveEngagementEventState
	HIVE SDK 가 특정한 조건에서 클라이언트에 개입 (Engagement) 하는 상태

Functions
static void	FHivePromotion::ShowPromotion (const EHivePromotionType &PromotionType, bool IsForced, const FHivePromotionViewDelegate &Delegate)
	Shows banner such as new event of game or introduce new game. More...

static void	FHivePromotion::ShowCustomContents (const EHivePromotionCustomType &PromotionCustomType, const FString &ContentsKey, const FHivePromotionViewDelegate &Delegate)
	Show custom Webview to use external content. More...

static void	FHivePromotion::ShowCustomContentsOnGameWindow (const EHivePromotionCustomType &PromotionCustomType, const FString &ContentsKey, const FHivePromotionViewDelegate &Delegate)
	Show custom Webview to use external content. More...

static EHiveOfferwallState	FHivePromotion::GetOfferwallState ()
	Returns whether the button is available to invoke an offerwall (free recharging station) within the game. More...

static void	FHivePromotion::ShowOfferwall (const FHivePromotionViewDelegate &Delegate)
	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	FHivePromotion::ShowNews (const FString &Menu, const TArray< int32 > &GiftPidList, const FHivePromotionViewDelegate &Delegate)
	Shows banner such as new event of game or introduce new game. More...

static void	FHivePromotion::ShowNativeReview ()
	Show review popup Positive ratings and reviews of game users will affect other users' use of the game. More...

static void	FHivePromotion::ShowReview (const FHivePromotionViewDelegate &Delegate)
	Show review popup Positive ratings and reviews of game users will affect other users' use of the game. More...

static void	FHivePromotion::ShowExit (const FHivePromotionViewDelegate &Delegate)
	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	FHivePromotion::GetViewInfo (const EHivePromotionCustomType &PromotionCustomType, const FString &ContentsKey, const FHivePromotionOnViewInfoDelegate &Delegate)
	Request HIVE Promotion Webview information so that your UI of webview is configured according to the concept of game UI More...

static void	FHivePromotion::GetBadgeInfo (const FHivePromotionOnBadgeInfoDelegate &Delegate)
	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	FHivePromotion::GetBannerInfo (const EHivePromotionCampaignType &CampaignType, const EHivePromotionBannerType &BannerType, const FHivePromotionOnBannerInfoDelegate &Delegate)
	Request banner information Request banner information for a specific promotion. More...

static void	FHivePromotion::GetBannerInfoString (const FString &CampaignString, const FString &BannerString, const FHivePromotionOnBannerInfoDelegate &Delegate)
	Request banner information Request banner information for a specific promotion. More...

static void	FHivePromotion::GetAppInvitationData (const FHivePromotionOnAppInvitationDataDelegate &Delegate)
	Request user invite information User acquisition information is provided to attract more users in the game. More...

static void	FHivePromotion::SetAdditionalInfo (const FString &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...

static TOptional< FHiveResultAPI >	FHivePromotion::SetEngagementReady (bool IsReady)
	It sets whether Engagement event handling is enabled. More...

static bool	FHivePromotion::ProcessURI (const FString &URI)
	Parse the URI to make it an Event type. More...

static void	FHivePromotion::SetEngagementDelegate (const FHivePromotionOnEngagementDelegate &Delegate)
	It register the Engagement listener.

static void	FHivePromotion::ShowUAShare (const FString &InviteMessage, const FString &InviteLink, const FHivePromotionOnUAShareDelegate &Delegate)
	Show dialog to share UA url via SNS. More...

static void	FHivePromotion::UpdatePromotionData ()
	/~korean Promotion 정보 갱신 Promotion 새소식 페이지 등의 노출에 필요한 정보를 갱신한다. More...

static void	FHivePromotion::GetAppInvitationSenderInfo (const FHivePromotionOnAppInvitationSenderInfoDelegate &Delegate)
	return first sender's userInfo who sent UA share invitation First sender's information can be returned after SDK initialize, login and setEngagementReady(true) 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)

Enumeration Type Documentation

◆ EHiveOfferwallState

enum class EHiveOfferwallState

strong

Information of Offerwall(free charging station) button.

Enumerator
ENABLED	Offerwall Button can be exposed.
DISABLED	Offerwall Button cannot be exposed.
UNKNOWN	Unknown status whether available to expose buttons or not.

◆ EHivePromotionCustomType

enum class EHivePromotionCustomType

strong

Types of Promotion CustomView.

Enumerator
VIEW	Custom view.
BOARD	Custom board.
SPOT	Spot banner.
DIRECT	Direct campaign.

◆ EHivePromotionEventType

enum class EHivePromotionEventType

strong

Promotion view event types.

Enumerator
OPEN	When the Promotion View window opens.
CLOSE	When the Promotion View window is closed.
START_PLAYBACK	When Playback starts.
FINISH_PLAYBACK	When Playback is finished.
EXIT	When you choose to quit from the Quit (see more games) popup.

◆ EHivePromotionType

enum class EHivePromotionType

strong

Types of Promotion view.

Enumerator
BANNER_LEGACY	Full Banner.
BANNER	Full banner.
NEWS	News.
NOTICE	Notice.

Function Documentation

◆ GetAppInvitationData()

static void FHivePromotion::GetAppInvitationData ( const FHivePromotionOnAppInvitationDataDelegate & Delegate )

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

Delegate API call result.

◆ GetAppInvitationSenderInfo()

static void FHivePromotion::GetAppInvitationSenderInfo ( const FHivePromotionOnAppInvitationSenderInfoDelegate & Delegate )

static

return first sender's userInfo who sent UA share invitation First sender's information can be returned after SDK initialize, login and setEngagementReady(true)

Parameters

Delegate API call result listener

◆ GetBadgeInfo()

static void FHivePromotion::GetBadgeInfo ( const FHivePromotionOnBadgeInfoDelegate & Delegate )

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

Delegate API call result listener

◆ GetBannerInfo()

static void FHivePromotion::GetBannerInfo	(	const EHivePromotionCampaignType &	CampaignType,
		const EHivePromotionBannerType &	BannerType,
		const FHivePromotionOnBannerInfoDelegate &	Delegate
	)

static

Request banner information
Request banner information for a specific promotion.

Used to retrieve banner information from the game server.

Parameters

CampaignType	"event", "notice", "all", "cross"
Delegate	API call result listener

◆ GetBannerInfoString()

static void FHivePromotion::GetBannerInfoString	(	const FString &	CampaignString,
		const FString &	BannerString,
		const FHivePromotionOnBannerInfoDelegate &	Delegate
	)

static

Request banner information
Request banner information for a specific promotion.

Used to retrieve banner information from the game server.

Parameters

CampaignString	custom String campaign type
Delegate	API call result listener

◆ GetOfferwallState()

static EHiveOfferwallState FHivePromotion::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 FHivePromotion::GetViewInfo	(	const EHivePromotionCustomType &	PromotionCustomType,
		const FString &	ContentsKey,
		const FHivePromotionOnViewInfoDelegate &	Delegate
	)

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

◆ ProcessURI()

static bool FHivePromotion::ProcessURI ( const FString & URI )

static

Parse the URI to make it an Event type.

Parameters

URI	URI to parse

Returns: True if there is no problem parsing, false otherwise.

◆ SetAdditionalInfo()

static void FHivePromotion::SetAdditionalInfo ( const FString & 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

◆ SetEngagementReady()

static TOptional< FHiveResultAPI > FHivePromotion::SetEngagementReady ( bool IsReady )

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

IsReady Whether Engagement events can be processed.

Returns: Whether the API call was successful.

◆ ShowCustomContents()

static void FHivePromotion::ShowCustomContents	(	const EHivePromotionCustomType &	PromotionCustomType,
		const FString &	ContentsKey,
		const FHivePromotionViewDelegate &	Delegate
	)

static

Show custom Webview to use external content.

Parameters

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

◆ ShowCustomContentsOnGameWindow()

static void FHivePromotion::ShowCustomContentsOnGameWindow	(	const EHivePromotionCustomType &	PromotionCustomType,
		const FString &	ContentsKey,
		const FHivePromotionViewDelegate &	Delegate
	)

static

Show custom Webview to use external content.

(GameWindow)

Parameters

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

◆ ShowExit()

static void FHivePromotion::ShowExit ( const FHivePromotionViewDelegate & Delegate )

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 FHivePromotion::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
Review popup on the device with iOS 10.3 and later is available to rate and write reviews in apps.

◆ ShowNews()

static void FHivePromotion::ShowNews	(	const FString &	Menu,
		const TArray< int32 > &	GiftPidList,
		const FHivePromotionViewDelegate &	Delegate
	)

static

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

Parameters

Menu	Menu Management Name
Delegate	API call result handler

◆ ShowOfferwall()

static void FHivePromotion::ShowOfferwall ( const FHivePromotionViewDelegate & Delegate )

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

Delegate API call result listener

◆ ShowPromotion()

static void FHivePromotion::ShowPromotion	(	const EHivePromotionType &	PromotionType,
		bool	IsForced,
		const FHivePromotionViewDelegate &	Delegate
	)

static

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

Parameters

PromotionType Promotion View type

IsForced

If true, 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.

Delegate API call result listener

◆ ShowReview()

static void FHivePromotion::ShowReview ( const FHivePromotionViewDelegate & Delegate )

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
Depending on the settings of Hive console, Hive normal review popup or customized image review popup will be appeared.

◆ ShowUAShare()

static void FHivePromotion::ShowUAShare	(	const FString &	InviteMessage,
		const FString &	InviteLink,
		const FHivePromotionOnUAShareDelegate &	Delegate
	)

static

Show dialog to share UA url via SNS.

Parameters

InviteMessage	UA invite message
InviteLink	UA invite link
Delegate	API call result listener

◆ UpdatePromotionData()

static void FHivePromotion::UpdatePromotionData ( )

static

/~korean Promotion 정보 갱신
Promotion 새소식 페이지 등의 노출에 필요한 정보를 갱신한다.

/~english Update information of Promotion Update promotion data to show Promotion UI.

HIVE SDK for Unreal Engine

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ EHiveOfferwallState

◆ EHivePromotionCustomType

◆ EHivePromotionEventType

◆ EHivePromotionType

Function Documentation

◆ GetAppInvitationData()

◆ GetAppInvitationSenderInfo()

◆ GetBadgeInfo()

◆ GetBannerInfo()

◆ GetBannerInfoString()

◆ GetOfferwallState()

◆ GetViewInfo()

◆ ProcessURI()

◆ SetAdditionalInfo()

◆ SetEngagementReady()

◆ ShowCustomContents()

◆ ShowCustomContentsOnGameWindow()

◆ ShowExit()

◆ ShowNativeReview()

◆ ShowNews()

◆ ShowOfferwall()

◆ ShowPromotion()

◆ ShowReview()

◆ ShowUAShare()

◆ UpdatePromotionData()