콘솔에 이미지를 등록한 후 사용자에게 공지를 띄울 수 있습니다.
이미지 공지를 화면에 띄워 줍니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS ■ UNREAL_WINDOWS
void ShowImageNotices(FGamebaseImageNoticeConfiguration& Configuration, const FGamebaseErrorDelegate& CloseCallback, const FGamebaseImageNoticeEventDelegate& EventCallback = {});
Example
void USample::ShowImageNotices(int32 ColorR, int32 ColorG, int32 ColorB, int32 ColorA, int64 TimeOut)
{
FGamebaseImageNoticeConfiguration Configuration;
Configuration.BackgroundColor = FColor(ColorR, ColorG, colorB, colorA);
Configuration.TimeOut = TimeOut;
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetImageNotice()->ShowImageNotices(Configuration,
FGamebaseErrorDelegate::CreateLambda([=](const FGamebaseError* Error) {
// Called when the entire imageNotice is closed.
...
}),
FGamebaseSchemeEventDelegate::CreateLambda([=](const FString& Scheme, const FGamebaseError* Error) {
// Called when custom event occurred.
...
})
);
}
Parameter | Values | Description |
---|---|---|
BackgroundColor | FColor | 백그라운드 색상 |
TimeOut | int64 | 이미지 공지 최대 로딩 시간(단위: millisecond) default: 5000 |
CloseImageNotices API를 호출하여 현재 표시 중인 이미지 공지를 모두 종료할 수 있습니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS
void CloseImageNotices();
Gamebase 콘솔에 설정한 약관을 표시합니다.
ShowTermsView API는 웹뷰로 약관 창을 표시해줍니다. Game 의 UI 에 맞는 약관 창을 직접 제작하고자 하는 경우에는 QueryTerms API를 호출하여, Gamebase 콘솔에 설정한 약관 항목을 불러올 수 있습니다. 유저가 약관에 동의했다면 각 항목별 동의 여부를 UpdateTerms API를 통해 Gamebase 서버로 전송하시기 바랍니다.
약관 창을 화면에 띄워 줍니다. 유저가 약관에 동의를 했을 경우, 동의 여부를 서버에 등록합니다. 약관에 동의했다면 ShowTermsView API를 다시 호출해도 약관 창이 표시되지 않고 바로 성공 콜백이 반환됩니다. 단, Gamebase 콘솔에서 약관 재동의 항목을 필요 로 변경했다면 유저가 다시 약관에 동의할 때까지는 약관 창이 표시됩니다.
[주의]
- FGamebasePushConfiguration은 약관 창이 표시되지 않은 경우에는 null입니다(약관 창이 표시되었다면 항상 유효한 객체가 반환됩니다.).
- FGamebasePushConfiguration.bPushEnabled 값은 항상 true입니다.
- FGamebasePushConfiguration이 null이 아니라면 로그인 후에 Subsystem->GetPush()->RegisterPush()를 호출하세요.
FGamebaseTermsConfiguration
API | Mandatory(M) / Optional(O) | Description |
---|---|---|
bForceShow | O | 약관에 동의했다면 ShowTermsView API를 다시 호출해도 약관 창이 표시되지 않지만, 이를 무시하고 강제로 약관 창을 표시합니다. default: false |
bEnableFixedFontSize | O | 약관 창의 폰트 사이즈를 고정할지 결정합니다. default : false Android에 한함 |
FGamebaseShowTermsViewResult
Parameter | Values | Description |
---|---|---|
bIsTermsUIOpened | bool | true : 유저가 약관에 동의하여 약관 창이 종료되었습니다. false : 이미 약관에 동의하여 약관 창이 표시되지 않고 종료되었습니다. |
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS
void ShowTermsView(const FGamebaseDataContainerDelegate& Callback);
void ShowTermsView(const FGamebaseTermsConfiguration& Configuration, const FGamebaseDataContainerDelegate& Callback);
ErrorCode
Error | Error Code | Description |
---|---|---|
NOT_INITIALIZED | 1 | Gamebase가 초기화되어 있지 않습니다. |
LAUNCHING_SERVER_ERROR | 2001 | 론칭 서버에서 전달받은 항목에 약관 관련 내용이 없는 경우에 발생하는 에러입니다. 정상적인 상황이 아니므로 Gamebase 담당자에게 문의해주시기 바랍니다. |
UI_TERMS_ALREADY_IN_PROGRESS_ERROR | 6924 | Terms API 호출이 아직 완료되지 않았습니다. 잠시 후 다시 시도하세요. |
UI_TERMS_ANDROID_DUPLICATED_VIEW | 6925 | 약관 웹뷰가 아직 종료되지 않았는데 다시 호출되었습니다. |
WEBVIEW_TIMEOUT | 7002 | 약관 웹뷰 표시 중 타임아웃이 발생했습니다. |
WEBVIEW_HTTP_ERROR | 7003 | 약관 웹뷰 오픈 중 HTTP 에러가 발생하였습니다. |
Example
void USample::ShowTermsView()
{
FGamebaseTermsConfiguration Configuration { true };
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetTerms()->ShowTermsView(Configuration,
FGamebaseDataContainerDelegate::CreateLambda([=](const FGamebaseDataContainer* DataContainer, const FGamebaseError* Error) {
if (Gamebase::IsSuccess(Error))
{
UE_LOG(GamebaseTestResults, Display, TEXT("ShowTermsView succeeded."));
const auto result = FGamebaseShowTermsResult::From(DataContainer);
if (result.IsValid())
{
// Save the 'PushConfiguration' and use it for RegisterPush() after Login().
SavedPushConfiguration = FGamebasePushConfiguration::From(DataContainer);
}
}
else
{
UE_LOG(GamebaseTestResults, Display, TEXT("ShowTermsView failed. (Error: %d)"), Error->Code);
}
})
);
}
void USample::AfterLogin()
{
// Call RegisterPush with saved PushConfiguration.
if (SavedPushConfiguration != null)
{
Gamebase.Push.RegisterPush(SavedPushConfiguration, (Error) =>
{
...
});
}
}
Gamebase는 단순한 형태의 웹뷰로 약관을 표시합니다. 게임UI에 맞는 약관을 직접 제작하고자 하신다면, QueryTerms API를 호출하여 Gamebase 콘솔에 설정한 약관 정보를 내려받아 활용하실 수 있습니다.
'선택' 약관 항목은 로그인 후에 호출하면 동의 여부도 함께 알 수 있습니다. 단, '필수' 항목의 동의 여부는 항상 false로 반환됩니다.
[주의]
- GamebaseResponse.Terms.ContentDetail.required가 true인 필수 항목은 동의 여부를 Gamebase 서버에 저장하지 않으므로 bAgreed 값은 항상 false로 반환됩니다.
- 약관 필수 항목에 동의하지 않은 경우 게임 진행 또는 게임 로그인을 시켜서는 안되므로, 약관 팝업이 닫혀 있고 로그인 되어 있는 상태 라면 자연스럽게 약관 필수 항목에 동의한 것과 같습니다. 그래서 로그인 한 유저는 이미 필수 항목에 모두 동의한 상태이므로, 굳이 동의 여부를 저장할 필요가 없기 때문입니다.
- 푸시 수신 동의 여부도 Gamebase 서버에 저장되지 않으므로 bAgreed 값은 항상 false로 반환됩니다.
- 유저의 푸시 수신 동의 여부는 Gamebase.Push.QueryPush API를 통해 확인하시기 바랍니다.
- 콘솔에서 '기본 약관 설정'을 하지 않는 경우 약관 언어와 다른 국가 코드로 설정된 단말기에서 queryTerms API를 호출하면
UI_TERMS_NOT_EXIST_FOR_DEVICE_COUNTRY(6922)
오류가 발생합니다.
- 콘솔에서 '기본 약관 설정'을 하거나,
UI_TERMS_NOT_EXIST_FOR_DEVICE_COUNTRY(6922)
오류가 발생했을 때는 약관을 표시하지 않도록 처리하시기 바랍니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS ■ UNREAL_WINDOWS
void QueryTerms(const FGamebaseQueryTermsResultDelegate& Callback);
ErrorCode
Error | Error Code | Description |
---|---|---|
NOT_INITIALIZED | 1 | Gamebase가 초기화되어 있지 않습니다. |
UI_TERMS_NOT_EXIST_IN_CONSOLE | 6921 | 약관 정보가 콘솔에 등록되어 있지 않습니다. |
UI_TERMS_NOT_EXIST_FOR_DEVICE_COUNTRY | 6922 | 단말기 국가코드에 맞는 약관 정보가 콘솔에 등록되어 있지 않습니다. |
Example
void USample::QueryTerms()
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetTerms()->QueryTerms(
FGamebaseQueryTermsResultDelegate::CreateLambda([=](const FGamebaseQueryTermsResult* Data, const FGamebaseError* Error) {
if (Gamebase::IsSuccess(Error))
{
UE_LOG(GamebaseTestResults, Display, TEXT("QueryTerms succeeded."));
}
else
{
UE_LOG(GamebaseTestResults, Display, TEXT("QueryTerms failed. (Error: %d)"), Error->Code);
}
})
);
}
Parameter | Values | Description |
---|---|---|
TermsSeq | int32 | 약관 전체 KEY. updateTerms API 호출 시 필요한 값입니다. |
TermsVersion | FString | 약관 버전. updateTerms API 호출 시 필요한 값입니다. |
termsCountryType | FString | 약관 타입. - KOREAN: 한국 약관 - GDPR: 유럽 약관 - ETC: 기타 약관 |
Contents | TArray |
약관 항목 정보 |
Parameter | Values | Description |
---|---|---|
TermsContentSeq | int32 | 약관 항목 KEY |
Name | FString | 약관 항목 이름 |
Required | bool | 필수 동의 여부 |
AgreePush | FString | 광고성 푸시 동의 여부 - NONE: 동의 안 함 - ALL: 전체 동의 - DAY: 주간 푸시 동의 - NIGHT: 야간 푸시 동의 |
bAgreed | bool | 해당 약관 항목에 대한 유저 동의 여부 |
Node1DepthPosition | int32 | 1단계 항목 노출 순서 |
Node2DepthPosition | int32 | 2단계 항목 노출 순서 없을 경우 -1 |
DetailPageUrl | FString | 약관 자세히 보기 URL 없을 경우 null. |
QueryTerms API로 내려받은 약관 정보로 UI를 직접 제작했다면, 게임유저가 약관에 동의한 내역을 UpdateTerms API를 통해 Gamebase 서버로 전송하시기 바랍니다.
선택 약관 동의를 취소하는 것과 같이, 약관에 동의했던 내역을 변경하는 목적으로도 활용하실 수 있습니다.
[주의]
푸시 수신 동의 여부는 Gamebase 서버에 저장되지 않습니다. 푸시 수신 동의 여부는 로그인 후에 Gamebase.Push.RegisterPush API를 호출해서 저장하세요.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS ■ UNREAL_WINDOWS
void UpdateTerms(const FGamebaseUpdateTermsConfiguration& Configuration, const FGamebaseErrorDelegate Callback);
ErrorCode
Error | Error Code | Description |
---|---|---|
NOT_INITIALIZED | 1 | Gamebase가 초기화되어 있지 않습니다. |
UI_TERMS_UNREGISTERED_SEQ | 6923 | 등록되지 않은 약관 Seq 값을 설정하였습니다. |
UI_TERMS_ALREADY_IN_PROGRESS_ERROR | 6924 | Terms API 호출이 아직 완료되지 않았습니다. 잠시 후 다시 시도하세요. |
Example
void USample::UpdateTerms(int32 TermsSeq, const FString& TermsVersion, int32 TermsContentSeq, bool bAgreed)
{
TArray<FGamebaseTermsContent> Contents;
Contents.Add(FGamebaseTermsContent { TermsContentSeq, bAgreed });
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetTerms()->UpdateTerms(
FGamebaseUpdateTermsConfiguration { TermsSeq, TermsVersion, Contents },
FGamebaseErrorDelegate::CreateLambda([=](const FGamebaseError* Error) {
if (Gamebase::IsSuccess(Error))
{
UE_LOG(GamebaseTestResults, Display, TEXT("UpdateTerms succeeded."));
}
else
{
UE_LOG(GamebaseTestResults, Display, TEXT("UpdateTerms failed. (Error: %d)"), Error->Code);
}
})
);
}
Parameter | Mandatory(M) / Optional(O) | Values | Description |
---|---|---|---|
TermsVersion | M | FString | 약관 버전. queryTerms API를 호출해 내려받은 값을 전달해야 합니다. |
TermsSeq | M | int32 | 약관 전체 KEY. queryTerms API를 호출해 내려받은 값을 전달해야 합니다. |
Contents | M | List< Content > | 선택 약관 유저 동의 정보 |
Parameter | Mandatory(M) / Optional(O) | Values | Description |
---|---|---|---|
TermsContentSeq | M | int32 | 선택 약관 항목 KEY |
bAgreed | M | bool | 선택 약관 항목 동의 여부 |
현재 약관 창이 화면에 표시되고 있는지 여부를 알 수 있습니다.
API
bool IsShowingTermsView();
Example
void USample::IsShowingTermsView()
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
bool isShowingTermsView = Subsystem->GetTerms()->IsShowingTermsView();
UE_LOG(GamebaseTestResults, Display, TEXT("IsShowingTermsView : %s"), isShowingTermsView ? TEXT("true") : TEXT("false"));
}
웹뷰를 표시합니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS ■ UNREAL_WINDOWS
void ShowWebView(const FString& Url, const FGamebaseWebViewConfiguration& Configuration, FGamebaseErrorDelegate& CloseCallback, const TArray<FString>& SchemeList, const FGamebaseSchemeEventDelegate& onSchemeEvent);
Example
void USample::ShowWebView(const FString& Url)
{
FGamebaseWebViewConfiguration Configuration;
Configuration.Title = TEXT("Title");
TArray<FString> SchemeList{ TEXT("customScheme://openBrowser") };
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetWebView()->ShowWebView(Url, Configuration,
FGamebaseErrorDelegate::CreateLambda([=](const FGamebaseError* Error) {
Result(ANSI_TO_TCHAR(__FUNCTION__), TEXT("Close webview"));
}),
SchemeList,
FGamebaseSchemeEventDelegate::CreateLambda([=](const FString& Scheme, const FGamebaseError* Error) {
if (Gamebase::IsSuccess(Error))
{
Result(ANSI_TO_TCHAR(__FUNCTION__), true, *FString::Printf(TEXT("Scheme= %s"), *Scheme));
}
else
{
Result(ANSI_TO_TCHAR(__FUNCTION__), false, GamebaseJsonUtil::UStructToJsonObjectString(*Error));
}
}));
}
Parameter | Values | Description |
---|---|---|
Title | FString | 웹뷰의 제목 |
Orientation | GamebaseScreenOrientation::Unspecified | 미지정(default) |
GamebaseScreenOrientation::Portrait | 세로 모드 | |
GamebaseScreenOrientation::Landscape | 가로 모드 | |
GamebaseScreenOrientation::LandscapeReverse | 가로 모드를 180도 회전 | |
ContentMode | GamebaseWebViewContentMode::Recommended | 현재 플랫폼 추천 브라우저(default) |
GamebaseWebViewContentMode::Mobile | 모바일 브라우저 | |
GamebaseWebViewContentMode::Desktop | 데스크톱 브라우저 | |
NavigationColor | FColor | 내비게이션 바 색상 default: FColor(18, 93, 230, 255) |
NavigationBarHeight | height | 내비게이션 바 높이 Android에 한함 |
bIsNavigationBarVisible | true or false | 내비게이션 바 활성 또는 비활성 default: true |
bIsBackButtonVisible | true or false | 뒤로 가기 버튼 활성 또는 비활성 default: true |
BackButtonImageResource | ID of resource | 뒤로 가기 버튼 이미지 |
CloseButtonImageResource | ID of resource | 닫기 버튼 이미지 |
bEnableFixedFontSize | true or false | 약관 창의 글자 크기 고정 여부를 결정합니다. default: false Android에 한함 |
bRenderOutSideSafeArea | true or false | Safe Area 영역 밖 렌더링 여부를 결정합니다. default: false Android에 한함 |
[TIP]
iPadOS 13 이상에서 웹뷰는 기본적으로 데스크톱 모드입니다. contentMode =
GamebaseWebViewContentMode::MOBILE
설정으로 모바일 모드로 변경할 수 있습니다.
Gamebase에서 지정해 놓은 스킴입니다.
Scheme | 용도 |
---|---|
gamebase://dismiss | 웹뷰 닫기 |
gamebase://getMaintenanceInfo | 점검 내용을 WebPage에 표시 |
gamebase://getUserId | 현재 로그인된 게임 유저의 사용자 ID를 표시 |
gamebase://goBack | 웹뷰 뒤로 가기 |
다음 API를 이용해 보이는 웹뷰를 닫을 수 있습니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS ■ UNREAL_WINDOWS
void CloseWebView();
ExampleCloseWebview
void USample::CloseWebView()
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetWebView()->CloseWebView();
}
다음 API를 통하여 외부 브라우져를 열 수 있습니다. 파라미터로 전송되는 url은 유효한 값이어야 합니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS
void OpenWebBrowser(const FString& Url);
Example
void USample::OpenWebBrowser(const FString& Url)
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetWebView()->OpenWebBrowser(Url);
}
시스템 알림을 표시할 수 있습니다. 시스템 알림에 콜백을 등록할 수도 있습니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS
void ShowAlert(const FString& Title, const FString& Message);
void ShowAlert(const FString& Title, const FString& Message, const FGamebaseAlertCloseDelegate& CloseCallback);
Example
void USample::ShowAlert(const FString& Title, const FString& Message)
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetUtil()->ShowAlert(Title, Message);
}
void USample::ShowAlertEvent(const FString& Title, const FString& Message)
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetUtil()->ShowAlert(Title, Message, FGamebaseAlertCloseDelegate::CreateLambda([=]()
{
UE_LOG(GamebaseTestResults, Display, TEXT("ShowAlert ButtonClick."));
}));
}
다음 API를 사용하여 쉽게 메시지를 표시할 수 있습니다.
API
Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS
void ShowToast(const FString& Message, EGamebaseToastExposureTime ExposureTimeType);
Example
void USample::ShowToast(const FString& Message, EGamebaseToastExposureTime ExposureTimeType)
{
UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
Subsystem->GetUtil()->ShowToast(Message, ExposureTimeType);
}
Error | Error Code | Description |
---|---|---|
UI_IMAGE_NOTICE_TIMEOUT | 6901 | 이미지 공지 표시 중 타임아웃이 발생했습니다. |
UI_UNKNOWN_ERROR | 6999 | 알수 없는 오류입니다(정의되지 않은 오류입니다). |