Tổng quan về API
Để đơn giản hoá trong việc phát triển app trên Tiki. Tini App Framework cung cấp đa dạng các JSAPI cần thiết để truy cập tới thiết bị, giao diện cũng như open services của Tiki.
Demo
Trải nghiệm thử với trình giả lập bên dưới
Basic
Tên | Mô tả |
---|---|
my.canIUse | Kiểm tra xem liệu Runtime của Tiki App Framework cài trên Tiki App có hỗ trợ hay không |
my.exitMiniApp | Đóng miniapp hiện tại |
my.getAppIdSync | Lấy ID của Mini App hiện tại |
my.getAppSecret | Lấy thông tin secret của Tini App hiện tại |
my.getLaunchOptionsSync | Lấy parameters để launch Tini App hiện tại |
my.getRunScene | Lấy version của Mini App đang chạy |
my.SDKVersion | Lấy version hiện tại của SDK |
In-App Event
Tên | Mô tả |
---|---|
my.offAppError | Dùng để remove listener của event `onAppError` từ trước |
my.offUnhandledRejection | Dùng để remove listener của event `onUnhandledRejection` từ trước |
my.offAppHide | Dùng để remove listener của event `onAppHide` từ trước |
my.offAppShow | Dùng để remove listener của event `onAppShow` từ trước |
my.onAppError | Dùng để lắng nghe sự kiện app error khi có error xảy ra trong lúc gọi api, tương đương với function `onError` trong app.js |
my.onUnhandledRejection | Dùng để lắng nghe sự kiện khi 1 Promise reject xảy ra nhưng không được handle, tương đương với function `onUnhandledRejection` trong app.js |
my.onAppHide | Dùng để lắng nghe sự kiện app hide (app enter background), tương đương với function `onHide` trong app.js |
my.onAppShow | dùng để lắng nghe sự kiện app show, tương đương với function `onShow` trong app.js |
UI
Navigation Bar
Tên | Mô tả |
---|---|
my.addIconsToNavigationBar | Thêm icons vào navigation bar bên cạnh nút ba chấm nằm ngang (⋯) mở menu |
my.getTitleColor | Lấy background color của Navigation Bar |
my.showAddToDevice | Hiển thị nút lưu tiện ích xuống thiết bị trên Title Bar |
my.hideBackHome | Ẩn đi nút back trên Title Bar |
my.hideNavigationBarLoading | Ẩn đi loading animation trên thanh Navigation Bar của page hiện tại |
my.setNavigationBar | Set style cho Navigation Bar |
my.showNavigationBarLoading | Hiển thị loading animation trên thanh Navigation Bar của page hiện tại |
Tab Bar
Tên | Mô tả |
---|---|
my.hideTabBarRedDot | Ẩn đi nút đỏ ở góc trên bên phải của một Tab Bar Item |
my.hideTabBar | Ẩn đi thanh Tab Bar |
my.removeTabBarBadge | Bỏ đi badge text cho một Tab Bar Item |
my.setTabBarBadge | Thêm badge text vào một Tab bar item |
my.setTabBarItem | Thay đổi các thuộc tính của một Tab bar item, bao gồm text, icon khi item ở trạng thái bình thường, và icon ở trạng thái được chọn (selected) |
my.setTabBarStyle | Set style cho Tab Bar |
my.showTabBarRedDot | Hiển thị nốt đỏ ở góc trên phải của một Tab Bar Item |
my.showTabBar | Hiển thị lại tab bar sau khi ẩn |
Route
Tên | Mô tả |
---|---|
my.navigateBackMiniApp | Dùng để quay lại app trước đó hoặc nhảy tới 1 app bất kỳ đã được mở trước đó |
my.navigateBack | Dùng để đóng màn hình hiện tại và trở lại màn hình trước đó |
my.navigateToMiniApp | Dùng để di chuyển giữa các app |
my.navigateTo | Dùng để di chuyển từ màn hình hiện tại tới màn hình mong muốn trong ứng dụng |
my.reLaunch | Dùng để đóng tất cả các pages hiện tại và nhảy tới một page nào đó trong ứng dụng |
my.redirectTo | Dùng để di chuyển từ màn hình hiện tại tới màn hình mong muốn trong ứng dụng |
my.reLaunchMiniApp | Giống với `my.navigateToMiniApp` tuy nhiên thay vì được chồng lên Tiniapp cũ, Tiniapp mới sẽ replace luôn Tiniapp cũ |
my.switchTab | Dùng để nhảy về một tab ở màn hình home |
Feedback
Tên | Mô tả |
---|---|
my.alert | Hiển thị alert |
my.confirm | Hiển thị confirm popup |
my.hideLoading | Ẩn loading |
my.hideToast | Ẩn toast |
my.prompt | Hiển thị prompt popup, để user có thể nhập giá tri vào |
my.showActionSheet | Hiển thị bottom popup để user có thể chọn option |
my.showLoading | Hiển thị loading |
my.showToast | Hiển thị toast từ top và tự hide đi sau 1 khoảng thời gian |
Pull-down
Tên | Mô tả |
---|---|
my.setCanPullDown | Set lại việc có hỗ trợ kéo xuống để refresh hay ko. Mặc định thì page hỗ trợ kéo xuống để refresh |
my.startPullDownRefresh | Active tính năng pull down to refresh, khi được gọi sẽ có animation loading tương đương với việc manual pull down list |
my.stopPullDownRefresh | Stop loading khi đã gọi `my.startPullDownRefresh` hoặc manual pull down |
Animation
Tên | Mô tả |
---|---|
my.createAnimation | Tạo ra một animation instance |
Canvas
Tên | Mô tả |
---|---|
my.createCanvasContext | Tạo ra canvas drawing context |
Keyboard
Tên | Mô tả |
---|---|
my.hideKeyboard | Ẩn bàn phím |
Selector Query
Tên | Mô tả |
---|---|
my.createSelectorQuery | Dùng để tạo SelectorQuery object |
Cascade selection
Tên | Mô tả |
---|---|
my.multiLevelSelect | Tạo component select đa cấp |
Multilevel select
Tên | Mô tả |
---|---|
my.multiLevelSelect | Tạo component select đa cấp |
Background
Tên | Mô tả |
---|---|
my.setBackgroundColor | Thay đổi màu nền của page |
my.setBackgroundTextStyle | Thay đổi font và color của text khi pull down để refresh |
Option Selector
Tên | Mô tả |
---|---|
my.optionsSelect | Dùng để tạo component Select. Bạn có thể tạo component Select 1 cấp hoặc 2 cấp |
Page Scroll To
Tên | Mô tả |
---|---|
my.pageScrollTo | Dùng để scroll đến vị trí bất kỳ trong trang |
Date Picker
Tên | Mô tả |
---|---|
my.datePicker | Cho phép user chọn thời gian |
Font
Tên | Mô tả |
---|---|
my.loadFontFace | Load 1 web font |
Media
Image
Tên | Mô tả |
---|---|
my.chooseImage | dùng để chụp ảnh bằng camera hoặc chọn hình từ album cục bộ |
my.compressImage | Dùng để nén nhiều ảnh (image) cùng một lúc, khiến chúng có dung lượng nhỏ hơn nhưng vẫn giữ nguyên kích thước ban đầu |
my.createCropperContext | Dùng để tạo ra ImageCropperContext - đối tượng cung cấp phương thức giúp bạn điều khiển `image-cropper` component |
my.cropImage | Dùng để crop hình ảnh |
my.getImageInfo | Dùng để lấy thông tin của 1 ảnh (image). Ảnh có thể từ remote, từ đường dẫn cục bộ hoặc từ resources của app |
my.previewImage | Cho phép mở một cửa sổ lớn để xem hình ảnh |
my.saveImage | Dùng để lưu 1 remote image vào gallery của thiết bị di động |
Audio
Tên | Mô tả |
---|---|
my.createAudioContext | Dùng để tạo ra AudioContext - đối tượng quản lý việc phát audio trên Tini App |
my.createInnerAudioContext | Dùng để tạo ra InnerAudioContext - đối tượng cung cấp cho bạn các phương thức và thuộc tính để phát audio nền (background audio) trên Tini App |
Video
Tên | Mô tả |
---|---|
my.chooseVideo | Dùng để quay video hoặc chọn video từ album cục bộ |
my.compressVideo | Dùng để nén video khiến chúng có dung lượng nhỏ hơn |
my.createVideoContext | dùng để tạo ra VideoContext - đối tuợng quản lý việc phát video. Cụ thể hơn, nó cung cấp các hàm giúp điều khiển `video` component |
my.trimVideo | Cho phép cắt video trong 1 khoảng thời gian |
Lottie
Tên | Mô tả |
---|---|
my.createLottieContext | Dùng để tạo ra LottieContext - đối tượng cung cấp các thuôc tính và phương thức giúp bạn điều khiển `lottie` component |
Storage
Tên | Mô tả |
---|---|
my.clearStorage | Xoá toàn bộ dữ liệu của app |
my.getStorageInfo | Đọc ra thông tin storage của tiện ích như dung lượng sử dụng hiện tại, giới hạn, các keys đã được lưu |
my.getStorage | Lấy dữ liệu đã được lưu theo key |
my.removeStorage | Xoá dữ liệu đã được lưu theo key |
my.setStorage | Lưu trữ dữ liệu theo key, dữ liệu mới sẽ ghi đè dữ liệu cũ nếu cùng key |
Deeplink
Tên | Mô tả |
---|---|
my.openDeeplink | Open 1 deeplink |
File
Tên | Mô tả |
---|---|
my.getFileInfo | Dùng để lấy thông tin một tập tin cục bộ. Tập tin có thể ở dạng tạm hoặc được lưu |
my.getSavedFileInfo | Dùng để lấy thông tin tập tin được lưu cục bộ. Để lấy thông tin tập tin tạm |
my.getSavedFileList | Dùng để lấy thông tin tất cả các tập tin được lưu cục bộ của Tini App gọi API này |
my.openDocument | Dùng để xem trước file PDF. |
my.removeSavedFile | Dùng để xoá 1 local cache file |
my.saveFile | Dùng để lưu lại file về thiết bị từ 1 đường dẫn tạm thời (local temporary file) |
Geography
Location
Tên | Mô tả |
---|---|
my.getLocation | Dùng để lấy thông tin vị trí địa lí hiện tại của device |
Network
Tên | Mô tả |
---|---|
my.closeSocket | Dùng để đóng một WebSocket connection được mở trước đó |
my.connectSocket | Dùng để mở websocket connection trên ứng dụng |
my.downloadFile | Dùng để dowload file về máy. File sẽ được lưu trữ tạm ở device |
my.offSocketClose | Dừng lắng nghe sự kiện đóng WebSocket connection trước đó |
my.offSocketError | Dừng lắng nghe sự kiện error được tạo trước đó |
my.offSocketMessage | Dừng lắng nghe sự kiện message được thiết lập trước đó |
my.offSocketOpen | Dừng lắng nghe sự kiện mở WebSocket connection trước đó |
my.onSocketClose | Lắng nghe sự kiện mở close của WebSocket |
my.onSocketError | Lắng nghe sự kiện error trên WebSocket connection |
my.onSocketMessage | Lắng nghe sự kiện message nhận được từ WebSocket Server |
my.onSocketOpen | Lắng nghe sự kiện mở connection của WebSocket |
my.request | Dùng để thực hiện các network request. Hiện chỉ hỗ trợ những request qua giao thức https |
my.sendSocketMessage | Dùng để gửi dữ liệu thông qua một WebSocket connection |
my.uploadFile | Dùng để upload file từ máy lên server |
Device
Screen
Tên | Mô tả |
---|---|
my.getScreenBrightness | Dùng để lấy thông tin độ sáng màn hình |
my.setKeepScreenOn | Dùng để giữ màn hình luôn sáng |
my.offUserCaptureScreen | Dừng việc lắng nghe các sự kiện chụp màn hình |
my.onUserCaptureScreen | Lắng nghe các sự kiện chụp màn hình đang hoạt động do người dùng khởi tạo |
my.setScreenBrightness | Dùng để điều chỉnh độ sáng màn hình |
Setting
Tên | Mô tả |
---|---|
my.getSetting | Lấy thông tin cài đặt. Trả về kết quả cài đặt quyền của người dùng |
my.openAppSetting | Dùng để mở app cài đặt của hệ thống và hiển thị màn hình các cài đặt tuỳ biến của app hiện tại (nếu có) |
my.openSetting | Mở giao diện cài đặt |
Network
Tên | Mô tả |
---|---|
my.getNetworkType | Lấy thông tin kết nối mạng của thiết bị |
my.offNetworkStatusChange | Huỷ nhận sự kiện thay đổi trạng thái mạng của thiết bị |
my.onNetworkStatusChange | Nhận sự kiện thay đổi trạng thái mạng của thiết bị |
Vibrate
Tên | Mô tả |
---|---|
my.vibrateLong | Dùng để làm rung thiết bị, với thời gian rung 400ms |
my.vibrateShort | Dùng để làm rung thiết bị, với thời gian rung 40ms |
my.vibrate | Dùng để làm rung thiết bị, với thời gian rung 200ms |
Shake
Tên | Mô tả |
---|---|
my.watchShake | Dùng để nhận sự kiện lắc thiết bị |
Compass
Tên | Mô tả |
---|---|
my.offCompassChange | Dừng việc theo dõi dữ liệu compass |
my.onCompassChange | Theo dõi các sự kiện thay đổi dữ liệu compass |
my.startCompass | Start theo dõi dữ liệu compass |
my.stopCompass | Dừng theo dõi dữ liệu compass |
Accelerometer
Tên | Mô tả |
---|---|
my.offAcceleronmeterChange | Dừng việc theo dõi dữ liệu acceleronmeter |
my.onAcceleronmeterChange | Theo dõi các sự kiện thay đổi dữ liệu cảm biến gia tốc |
my.startAccelerometer | Lắng nghe các sự kiện thay đổi dữ liệu cảm biến gia tốc |
my.stopAccelerometer | Dừng lắng nghe các sự kiện thay đổi dữ liệu cảm biến gia tốc |
Contact
Tên | Mô tả |
---|---|
my.addPhoneContact | Dùng để chọn ghi thông tin liên hệ vào sổ địa chỉ của điện thoại dưới dạng "tạo một liên hệ mới" hoặc "thêm vào một liên hệ hiện có" |
my.choosePhoneContact | Dùng để chọn một liên hệ từ Danh bạ trong điện thoại của người dùng |
my.makePhoneCall | Dùng để gọi tới 1 số điện thoại cụ thể |
Clipboard
Tên | Mô tả |
---|---|
my.getClipboard | Dùng để lấy nội dung từ clipboard của thiết bị |
my.setClipboard | Dùng để đưa dữ liệu vào clipboard của thiết bị |
Scan
Tên | Mô tả |
---|---|
my.scan | Quét mã QR hoặc mã vạch (barcode) |
Bio metrics
local-authentication
Tên | Mô tả |
---|---|
my.bioMetrics.localAuth | Dùng để xác thực người dùng ở mức độ device |
server-authentication
Tên | Mô tả |
---|---|
my.bioMetrics.createKey | Tạo ra cặp public và private key RSA 2048, được lưu trữ vào keychain của ios hoặc keystore của android |
my.bioMetrics.createSignature | Tạo ra chuỗi signature từ challenge. Tham khảo full luồng xác thực người dùng bằng biometrics |
my.bioMetrics.deleteKey | Xoá cặp key đề cập ở my.bioMetrics.createKey |
my.bioMetrics.isSupported | Kiểm tra thiết bị có sensor của bio metrics hay không và đã cài đặt sẵn 1 trong các loại xác thực face id, touch id hoặc móng mắt (tuỳ thuộc vào thiết bị)... hay chưa |
my.bioMetrics.keyExists | Kiểm tra thiết bị đã có lưu sẵn cặp key đề cập ở JSAPI my.bioMetrics.createKey |
Security Storage
Tên | Mô tả |
---|---|
my.getEncryptedStorage | Lấy dữ liệu đã được lưu theo key |
my.getAllKeysEncryptedStorage | Lấy toàn bộ key của app |
my.removeEncryptedStorage | Xoá dữ liệu đã được lưu theo key |
my.setEncryptedStorage | Lưu trữ dữ liệu theo key, dữ liệu mới sẽ ghi đè dữ liệu cũ nếu cùng key |
Permission
Tên | Mô tả |
---|---|
my.checkNativePermissions | Kiểm tra người dùng đã bật các quyền cho Tiki app hay chưa |
my.checkNotification | Kiểm tra người dùng đã bật notification cho Tiki app hay chưa |
Others
Tên | Mô tả |
---|---|
my.getBatteryInfo | Dùng để lấy thông tin pin của thiết bị |
my.getSystemInfo | Dùng để lấy thông tin của hệ thống |
Open
Tên | Mô tả |
---|---|
my.getAddress | Dùng để chọn một địa chỉ từ Sổ địa chỉ của Tiki. Yêu cầu người dùng phải đăng nhập trước |
my.saveAddress | Dùng để lưu địa chỉ vào Sổ địa chỉ của Tiki. Yêu cầu người dùng phải đăng nhập trước |
my.getAuthCode | Lấy ra auth code của một user |
my.getUserInfo | Lấy các thông tin cơ bản của users (tên, ảnh, số điện thoại, email và tiki user id) |
my.addToCart | Thêm 1 hoặc nhiều sản phẩm vào giỏ hàng (cart) của Tiki |
my.callSecuritySystem | Xác thực người dùng khi gọi các APIs lấy dữ liệu từ hệ thống Tiki |
my.getCart | Trả về tổng sản phẩm đang có trong giỏ hàng (cart) của Tiki, được lọc theo sellerId |
my.isLoggedIn | Kiểm tra user đã log in hay chưa |
my.makePayment | Tạo payment |
my.openNativeAppStore | Dùng để truy cập đến một ứng dụng trên Apple Store hay Google Play Store |
my.openScreen | Dùng để mở 1 số màn hình của Tiki |
my.setChatSellerProfileId | Dùng để set chat seller profile Id |
my.askDownloadNewClient | Dùng để kiểm tra Tiki App cài trên thiết bị di động có phải là phiên bản mới nhất không |
Ads
Tên | Mô tả |
---|---|
my.createInterstitialAd | Hiển thị quảng cáo dạng popup. Khi dùng jsapi này sẽ trả ra 1 instance `interstitial-ad` |
Tên | Mô tả |
---|---|
Interstitiad.destroy | Đóng quảng cáo |
Interstitiad.load | Tải quảng cáo |
Interstitiad.offClose | Huỷ việc lắng nghe sự kiện quảng cáo bị đóng |
Interstitiad.offError | Huỷ việc lắng nghe sự kiện quảng cáo bị lỗi |
Interstitiad.offLoad | Huỷ việc lắng nghe sự kiện quảng cáo được load thành công |
Interstitiad.onClose | Lắng nghe sự kiện quảng cáo bị đóng |
Interstitiad.onError | Lắng nghe sự kiện hiển thị quảng cáo bị lỗi |
Interstitiad.onLoad | Lắng nghe sự kiện quảng cáo được load thành công |
Interstitiad.show | Hiển thị quảng cáo |
Analytics
Tên | Mô tả |
---|---|
my.reportAnalytics | Ghi nhận dữ liệu của một số sự kiện tuỳ chỉnh |