WebView SDK Documentation - v2.0.0
    Preparing search index...

    Variable MiniAppAPIConst

    MiniAppAPI: {
        appOpenStore: (
            payload: AppOpenStoreRequest,
        ) => Promise<MiniAppResponse<AppOpenStoreResponse>>;
        appOpenWebview: (
            payload: AppOpenWebviewRequest,
        ) => Promise<MiniAppResponse<AppOpenWebviewResponse>>;
        checkAudioPermission: () => Promise<
            MiniAppResponse<CheckAudioPermissionResponse>,
        >;
        checkCameraPermission: () => Promise<
            MiniAppResponse<CheckCameraPermissionResponse>,
        >;
        checkContactsPermission: () => Promise<
            MiniAppResponse<CheckContactsPermissionResponse>,
        >;
        checkDocumentPermission: () => Promise<
            MiniAppResponse<CheckDocumentPermissionResponse>,
        >;
        checkLocalAuthenticationPermission: () => Promise<
            MiniAppResponse<CheckLocalAuthenticationPermissionResponse>,
        >;
        checkLocationPermission: () => Promise<
            MiniAppResponse<CheckLocationPermissionResponse>,
        >;
        checkLoginPermission: () => Promise<
            MiniAppResponse<CheckLoginPermissionResponse>,
        >;
        checkMultipleUserDataPermission: (
            payload: CheckMultipleUserDataPermissionRequest,
        ) => Promise<MiniAppResponse<CheckMultipleUserDataPermissionResponse>>;
        checkPaymentPermission: () => Promise<
            MiniAppResponse<CheckPaymentPermissionResponse>,
        >;
        checkPhotosPermission: () => Promise<
            MiniAppResponse<CheckPhotosPermissionResponse>,
        >;
        checkRecordAudioPermission: () => Promise<
            MiniAppResponse<CheckRecordAudioPermissionResponse>,
        >;
        checkVideosPermission: () => Promise<
            MiniAppResponse<CheckVideosPermissionResponse>,
        >;
        clearPermissionCache: (
            payload: ClearPermissionCacheRequest,
        ) => Promise<MiniAppResponse<ClearPermissionCacheResponse>>;
        clearStorage: () => Promise<MiniAppResponse<ClearStorageResponse>>;
        executeLocalAuthentication: (
            payload?: ExecuteLocalAuthenticationRequest,
        ) => Promise<MiniAppResponse<ExecuteLocalAuthenticationResponse>>;
        exit: (payload: ExitRequest) => Promise<MiniAppResponse<ExitResponse>>;
        expiredSession: () => Promise<MiniAppResponse<ExpiredSessionResponse>>;
        getBooleanValue: (
            payload?: GetBooleanValueRequest,
        ) => Promise<MiniAppResponse<GetBooleanValueResponse>>;
        getContacts: (
            payload?: GetContactsRequest,
        ) => Promise<MiniAppResponse<GetContactsResponse>>;
        getFloatValue: (
            payload?: GetFloatValueRequest,
        ) => Promise<MiniAppResponse<GetFloatValueResponse>>;
        getIntegerValue: (
            payload?: GetIntegerValueRequest,
        ) => Promise<MiniAppResponse<GetIntegerValueResponse>>;
        getLocalAuthenticationStatus: () => Promise<
            MiniAppResponse<GetLocalAuthenticationStatusResponse>,
        >;
        getLocation: () => Promise<MiniAppResponse<GetLocationResponse>>;
        getLongValue: (
            payload?: GetLongValueRequest,
        ) => Promise<MiniAppResponse<GetLongValueResponse>>;
        getMultipleUserData: (
            payload: GetMultipleUserDataRequest,
        ) => Promise<MiniAppResponse<GetMultipleUserDataResponse>>;
        getStringValue: (
            payload?: GetStringValueRequest,
        ) => Promise<MiniAppResponse<GetStringValueResponse>>;
        init: (sendFn: SendRawFn) => void;
        initRequest: () => Promise<MiniAppResponse<InitRequestResponse>>;
        isSuccess: (response: MiniAppResponseBase) => boolean;
        miniAppToken: () => Promise<MiniAppResponse<MiniAppTokenResponse>>;
        openExternalLink: (
            payload: OpenExternalLinkRequest,
        ) => Promise<MiniAppResponse<OpenExternalLinkResponse>>;
        openInAppDeeplink: (
            payload: OpenInAppDeeplinkRequest,
        ) => Promise<MiniAppResponse<OpenInAppDeeplinkResponse>>;
        openMiniApp: (
            payload: OpenMiniAppRequest,
        ) => Promise<MiniAppResponse<OpenMiniAppResponse>>;
        openSmsComposer: (
            payload: OpenSmsComposerRequest,
        ) => Promise<MiniAppResponse<OpenSmsComposerResponse>>;
        requestAudioPermission: () => Promise<
            MiniAppResponse<RequestAudioPermissionResponse>,
        >;
        requestCameraPermission: () => Promise<
            MiniAppResponse<RequestCameraPermissionResponse>,
        >;
        requestContactsPermission: () => Promise<
            MiniAppResponse<RequestContactsPermissionResponse>,
        >;
        requestDocumentPermission: () => Promise<
            MiniAppResponse<RequestDocumentPermissionResponse>,
        >;
        requestLocalAuthenticationPermission: () => Promise<
            MiniAppResponse<RequestLocalAuthenticationPermissionResponse>,
        >;
        requestLocationPermission: () => Promise<
            MiniAppResponse<RequestLocationPermissionResponse>,
        >;
        requestLoginPermission: () => Promise<
            MiniAppResponse<RequestLoginPermissionResponse>,
        >;
        requestMultipleUserDataPermission: (
            payload: RequestMultipleUserDataPermissionRequest,
        ) => Promise<MiniAppResponse<RequestMultipleUserDataPermissionResponse>>;
        requestPaymentPermission: () => Promise<
            MiniAppResponse<RequestPaymentPermissionResponse>,
        >;
        requestPhotosPermission: () => Promise<
            MiniAppResponse<RequestPhotosPermissionResponse>,
        >;
        requestRecordAudioPermission: () => Promise<
            MiniAppResponse<RequestRecordAudioPermissionResponse>,
        >;
        requestVideosPermission: () => Promise<
            MiniAppResponse<RequestVideosPermissionResponse>,
        >;
        restoreScreenBrightness: (
            payload?: RestoreScreenBrightnessRequest,
        ) => Promise<MiniAppResponse<RestoreScreenBrightnessResponse>>;
        saveBooleanValue: (
            payload?: SaveBooleanValueRequest,
        ) => Promise<MiniAppResponse<SaveBooleanValueResponse>>;
        saveFile: (
            payload?: SaveFileRequest,
        ) => Promise<MiniAppResponse<SaveFileResponse>>;
        saveFloatValue: (
            payload?: SaveFloatValueRequest,
        ) => Promise<MiniAppResponse<SaveFloatValueResponse>>;
        saveImageToGallery: (
            payload?: SaveImageToGalleryRequest,
        ) => Promise<MiniAppResponse<SaveImageToGalleryResponse>>;
        saveIntegerValue: (
            payload?: SaveIntegerValueRequest,
        ) => Promise<MiniAppResponse<SaveIntegerValueResponse>>;
        saveLongValue: (
            payload?: SaveLongValueRequest,
        ) => Promise<MiniAppResponse<SaveLongValueResponse>>;
        saveStringValue: (
            payload?: SaveStringValueRequest,
        ) => Promise<MiniAppResponse<SaveStringValueResponse>>;
        setScreenBrightness: (
            payload: SetScreenBrightnessRequest,
        ) => Promise<MiniAppResponse<SetScreenBrightnessResponse>>;
        shareTextContent: (
            payload?: ShareTextContentRequest,
        ) => Promise<MiniAppResponse<ShareTextContentResponse>>;
        updateMiniAppTheme: (
            payload: UpdateMiniAppThemeRequest,
        ) => Promise<MiniAppResponse<UpdateMiniAppThemeResponse>>;
        wire: (app: { sendRaw(msg: MiniAppRequestBase): Promise<any> }) => void;
    } = ...

    Type Declaration

    • appOpenStore: (payload: AppOpenStoreRequest) => Promise<MiniAppResponse<AppOpenStoreResponse>>

      Mở ứng dụng từ App Store/Google Play hoặc launch app đã cài.

    • appOpenWebview: (
          payload: AppOpenWebviewRequest,
      ) => Promise<MiniAppResponse<AppOpenWebviewResponse>>

      Mở một WebView mới với URL và cấu hình tùy chỉnh.

    • checkAudioPermission: () => Promise<MiniAppResponse<CheckAudioPermissionResponse>>

      Kiểm tra quyền truy cập file audio

    • checkCameraPermission: () => Promise<MiniAppResponse<CheckCameraPermissionResponse>>

      Kiểm tra quyền camera

    • checkContactsPermission: () => Promise<MiniAppResponse<CheckContactsPermissionResponse>>

      Kiểm tra quyền truy cập danh bạ

    • checkDocumentPermission: () => Promise<MiniAppResponse<CheckDocumentPermissionResponse>>

      Kiểm tra quyền truy cập file tài liệu

    • checkLocalAuthenticationPermission: () => Promise<MiniAppResponse<CheckLocalAuthenticationPermissionResponse>>

      kiểm tra quyền xác thực sinh trắc học (vân tay, Face ID).

    • checkLocationPermission: () => Promise<MiniAppResponse<CheckLocationPermissionResponse>>

      Kiểm tra quyền vị trí

    • checkLoginPermission: () => Promise<MiniAppResponse<CheckLoginPermissionResponse>>
    • checkMultipleUserDataPermission: (
          payload: CheckMultipleUserDataPermissionRequest,
      ) => Promise<MiniAppResponse<CheckMultipleUserDataPermissionResponse>>

      Kiểm tra trạng thái nhiều quyền user data cùng lúc.

    • checkPaymentPermission: () => Promise<MiniAppResponse<CheckPaymentPermissionResponse>>
    • checkPhotosPermission: () => Promise<MiniAppResponse<CheckPhotosPermissionResponse>>

      Kiểm tra quyền truy cập ảnh

    • checkRecordAudioPermission: () => Promise<MiniAppResponse<CheckRecordAudioPermissionResponse>>

      Kiểm tra quyền ghi âm trên thiết bị

    • checkVideosPermission: () => Promise<MiniAppResponse<CheckVideosPermissionResponse>>

      Kiểm tra quyền truy cập video

    • clearPermissionCache: (
          payload: ClearPermissionCacheRequest,
      ) => Promise<MiniAppResponse<ClearPermissionCacheResponse>>

      Xóa tất cả quyền đã cache ở local.

    • clearStorage: () => Promise<MiniAppResponse<ClearStorageResponse>>

      Lấy giá trị kiểu float.

    • executeLocalAuthentication: (
          payload?: ExecuteLocalAuthenticationRequest,
      ) => Promise<MiniAppResponse<ExecuteLocalAuthenticationResponse>>

      Thực hiện xác thực sinh trắc học (vân tay, Face ID).

    • exit: (payload: ExitRequest) => Promise<MiniAppResponse<ExitResponse>>

      Đóng Mini App và điều hướng về màn hình khác.

    • expiredSession: () => Promise<MiniAppResponse<ExpiredSessionResponse>>

      Session expiration event, Delegate cho host app xử lý

    • getBooleanValue: (
          payload?: GetBooleanValueRequest,
      ) => Promise<MiniAppResponse<GetBooleanValueResponse>>

      Lấy giá trị kiểu boolean.

    • getContacts: (payload?: GetContactsRequest) => Promise<MiniAppResponse<GetContactsResponse>>

      Lấy danh sách contacts từ danh bạ hệ thống.

    • getFloatValue: (
          payload?: GetFloatValueRequest,
      ) => Promise<MiniAppResponse<GetFloatValueResponse>>

      Lấy giá trị kiểu float.

    • getIntegerValue: (
          payload?: GetIntegerValueRequest,
      ) => Promise<MiniAppResponse<GetIntegerValueResponse>>

      Lấy giá trị kiểu int.

    • getLocalAuthenticationStatus: () => Promise<MiniAppResponse<GetLocalAuthenticationStatusResponse>>

      lấy trạng thái xác thực sinh trắc học (vân tay, Face ID).

    • getLocation: () => Promise<MiniAppResponse<GetLocationResponse>>

      Lấy vị trí GPS hiện tại của thiết bị. Phải có quyền LOCATION_PERMISSION trước khi sử dụng API này.

    • getLongValue: (
          payload?: GetLongValueRequest,
      ) => Promise<MiniAppResponse<GetLongValueResponse>>

      Lấy giá trị kiểu long.

    • getMultipleUserData: (
          payload: GetMultipleUserDataRequest,
      ) => Promise<MiniAppResponse<GetMultipleUserDataResponse>>

      Lấy nhiều trường dữ liệu người dùng từ host app.

    • getStringValue: (
          payload?: GetStringValueRequest,
      ) => Promise<MiniAppResponse<GetStringValueResponse>>

      Lấy giá trị kiểu string.

    • init: (sendFn: SendRawFn) => void

      Khoi tao API module

    • initRequest: () => Promise<MiniAppResponse<InitRequestResponse>>

      Get init event

    • isSuccess: (response: MiniAppResponseBase) => boolean

      Kiem tra response thanh cong

    • miniAppToken: () => Promise<MiniAppResponse<MiniAppTokenResponse>>

      Get mini app token

    • Mở URL bằng browser mặc định của hệ thống.

    • Mở deeplink nội bộ app

    • openMiniApp: (payload: OpenMiniAppRequest) => Promise<MiniAppResponse<OpenMiniAppResponse>>

      Mở một Mini App khác từ Mini App hiện tại.

    • openSmsComposer: (
          payload: OpenSmsComposerRequest,
      ) => Promise<MiniAppResponse<OpenSmsComposerResponse>>

      Mở trình soạn tin nhắn của hệ điều hành với số nhận và nội dung điền sẵn. SDK KHÔNG gửi tin — người dùng tự bấm gửi trong trình soạn tin. ⚠️ Mở thành công trả về mã SDK852, KHÔNG phải SDK000, nên isSuccess() trả false và Promise bị REJECT dù mọi thứ đúng: hãy đọc kết quả trong nhánh catch, giá trị nhận được là nguyên response (đọc data.terminal_state). Đây là hành vi đã biết và được chấp nhận, không phải lỗi. Trên iOS còn một nhịp thứ hai mang kết cục thật, và nhịp đó KHÔNG đến qua Promise — phải nghe bằng app.on('OPEN_SMS_COMPOSER', cb).

    • requestAudioPermission: () => Promise<MiniAppResponse<RequestAudioPermissionResponse>>

      Yêu cầu truy cập audio trên thiết bị

    • requestCameraPermission: () => Promise<MiniAppResponse<RequestCameraPermissionResponse>>

      Yêu cầu mở camera

    • requestContactsPermission: () => Promise<MiniAppResponse<RequestContactsPermissionResponse>>

      Yêu cầu truy cập danh bạ trên thiết bị

    • requestDocumentPermission: () => Promise<MiniAppResponse<RequestDocumentPermissionResponse>>

      Yêu cầu truy cập tài liệu trên thiết bị

    • requestLocalAuthenticationPermission: () => Promise<MiniAppResponse<RequestLocalAuthenticationPermissionResponse>>

      Yêu cầu xác thực sinh trắc học (vân tay, Face ID).

    • requestLocationPermission: () => Promise<MiniAppResponse<RequestLocationPermissionResponse>>

      Yêu cầu vị trí

    • requestLoginPermission: () => Promise<MiniAppResponse<RequestLoginPermissionResponse>>
    • requestMultipleUserDataPermission: (
          payload: RequestMultipleUserDataPermissionRequest,
      ) => Promise<MiniAppResponse<RequestMultipleUserDataPermissionResponse>>

      Yêu cầu nhiều quyền user data cùng một lúc.

    • requestPaymentPermission: () => Promise<MiniAppResponse<RequestPaymentPermissionResponse>>
    • requestPhotosPermission: () => Promise<MiniAppResponse<RequestPhotosPermissionResponse>>

      Yêu cầu truy cập ảnh trên thiết bị

    • requestRecordAudioPermission: () => Promise<MiniAppResponse<RequestRecordAudioPermissionResponse>>

      Yêu cầu ghi âm trên thiết bị

    • requestVideosPermission: () => Promise<MiniAppResponse<RequestVideosPermissionResponse>>

      Yêu cầu truy cập video trên thiết bị

    • restoreScreenBrightness: (
          payload?: RestoreScreenBrightnessRequest,
      ) => Promise<MiniAppResponse<RestoreScreenBrightnessResponse>>

      Khôi phục độ sáng về giá trị đã lưu gần nhất theo session mini-app.

    • saveBooleanValue: (
          payload?: SaveBooleanValueRequest,
      ) => Promise<MiniAppResponse<SaveBooleanValueResponse>>

      Lưu giá trị kiểu boolean.

    • saveFile: (payload?: SaveFileRequest) => Promise<MiniAppResponse<SaveFileResponse>>

      Lưu file vào thư mục

    • saveFloatValue: (
          payload?: SaveFloatValueRequest,
      ) => Promise<MiniAppResponse<SaveFloatValueResponse>>

      Lưu giá trị kiểu float.

    • saveImageToGallery: (
          payload?: SaveImageToGalleryRequest,
      ) => Promise<MiniAppResponse<SaveImageToGalleryResponse>>

      Lưu ảnh vào bộ sưu tập

    • saveIntegerValue: (
          payload?: SaveIntegerValueRequest,
      ) => Promise<MiniAppResponse<SaveIntegerValueResponse>>

      Lưu giá trị kiểu int.

    • saveLongValue: (
          payload?: SaveLongValueRequest,
      ) => Promise<MiniAppResponse<SaveLongValueResponse>>

      Lưu giá trị kiểu long.

    • saveStringValue: (
          payload?: SaveStringValueRequest,
      ) => Promise<MiniAppResponse<SaveStringValueResponse>>

      Lưu giá trị kiểu string.

    • setScreenBrightness: (
          payload: SetScreenBrightnessRequest,
      ) => Promise<MiniAppResponse<SetScreenBrightnessResponse>>

      Đặt độ sáng màn hình (screen-scoped) cho màn hình mini-app đang hiển thị. Tự khôi phục khi rời màn/nền.

    • shareTextContent: (
          payload?: ShareTextContentRequest,
      ) => Promise<MiniAppResponse<ShareTextContentResponse>>

      Mở dialog chia sẻ nội dung text.

    • updateMiniAppTheme: (
          payload: UpdateMiniAppThemeRequest,
      ) => Promise<MiniAppResponse<UpdateMiniAppThemeResponse>>

      Update mini app theme

    • wire: (app: { sendRaw(msg: MiniAppRequestBase): Promise<any> }) => void

      Noi voi MiniApp instance (dung trong adapter)

    Settings
    Member Visibility