js-miniapp-sdk

Globals / MiniApp

Class: MiniApp

Hierarchy

• MiniApp

Implements

• MiniAppFeatures
• Ad
• Platform

Index

Properties

• chatService
• secureStorageService
• user

Methods

• downloadFile
• getHostEnvironmentInfo
• getMauid
• getMessagingUniqueId
• getPlatform
• getPoints
• getUniqueId
• loadInterstitialAd
• loadRewardedAd
• requestCustomPermissions
• requestLocationPermission
• setCloseAlert
• setScreenOrientation
• shareInfo
• showInterstitialAd
• showRewardedAd

Properties

chatService

• chatService: ChatService = new ChatService()

Defined in js-miniapp-sdk/src/miniapp.ts:162

secureStorageService

• secureStorageService: SecureStorageService = new SecureStorageService()

Defined in js-miniapp-sdk/src/miniapp.ts:163

user

• user: UserInfoProvider = new UserInfo()

Defined in js-miniapp-sdk/src/miniapp.ts:161

Methods

downloadFile

▸ downloadFile(filename: string, url: string, headers?: DownloadFileHeaders): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:268

Parameters:

Returns: Promise<string>

getHostEnvironmentInfo

▸ getHostEnvironmentInfo(): Promise<HostEnvironmentInfo>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:259

Returns: Promise<HostEnvironmentInfo>

getMauid

▸ getMauid(): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:180

Returns: Promise<string>

getMessagingUniqueId

▸ getMessagingUniqueId(): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:176

Returns: Promise<string>

getPlatform

▸ getPlatform(): string

Defined in js-miniapp-sdk/src/miniapp.ts:243

Returns: string

getPoints

▸ getPoints(): Promise<Points>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:255

Returns: Promise<Points>

getUniqueId

▸ getUniqueId(): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:172

deprecated Deprecated method for getting the uniqueId use getMessagingUniqueId or getMauid instead

Returns: Promise<string>

loadInterstitialAd

▸ loadInterstitialAd(id: string): Promise<string>

Implementation of Ad

Defined in js-miniapp-sdk/src/miniapp.ts:223

Parameters:

Returns: Promise<string>

loadRewardedAd

▸ loadRewardedAd(id: string): Promise<string>

Implementation of Ad

Defined in js-miniapp-sdk/src/miniapp.ts:227

Parameters:

Returns: Promise<string>

requestCustomPermissions

▸ requestCustomPermissions(permissions: CustomPermission[]): Promise<CustomPermissionResult[]>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:215

Parameters:

Returns: Promise<CustomPermissionResult[]>

requestLocationPermission

▸ requestLocationPermission(permissionDescription?: string): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:184

Parameters:

Returns: Promise<string>

setCloseAlert

▸ setCloseAlert(alertInfo: CloseAlertInfo): Promise<undefined>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:276

Parameters:

Returns: Promise<undefined>

setScreenOrientation

▸ setScreenOrientation(screenOrientation: ScreenOrientation): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:251

Parameters:

Returns: Promise<string>

shareInfo

▸ shareInfo(info: ShareInfoType): Promise<string>

Implementation of MiniAppFeatures

Defined in js-miniapp-sdk/src/miniapp.ts:239

Parameters:

Returns: Promise<string>

showInterstitialAd

▸ showInterstitialAd(id: string): Promise<string>

Implementation of Ad

Defined in js-miniapp-sdk/src/miniapp.ts:231

Parameters:

Returns: Promise<string>

showRewardedAd

▸ showRewardedAd(id: string): Promise<Reward>

Implementation of Ad

Defined in js-miniapp-sdk/src/miniapp.ts:235

Parameters:

Returns: Promise<Reward>