Các API Runtime

Tài liệu sau đây mô tả các API mà Runtime cần cung cấp để có thể sử dụng Tbox Mini App SDK

env

Hàm này trả về một dictionary các biến môi trường cần được sử dụng bởi Tbox Mini App SDK.

env(): Object

Các biến này bao gồm các key sau

tên trường	kiểu dữ liệu	bắt buộc phải có	ý nghĩa
API_GATEWAY	string	có	domain của API gateway dùng để lấy bundle version, cũng như identity
HOST	string	có	tên của host đang sử dụng, ví dụ: TIKI, TICKETBOX, ZALO

getUser

Hàm này được sử dụng để cài đặt hàm getUser

async function getUser(): User | null

Trong đó User là một object có chứa các key

tên trường	kiểu dữ liệu	bắt buộc phải có	ý nghĩa
id	string	có	id của user
name	string	có	tên của user
image_url	string	không	ảnh đại diện của user
email	string	không	email của user
phone_number	string	không	số điện thoại của user
access_token	string	không	token để access các thông tin khác của user

getDeviceId

Hàm này được sử dụng để cài đặt hàm getUser

async function getDeviceId(): string

Mỗi một platform cần cung cấp hàm getDeviceId, hàm getDeviceId cần trả về một chuỗi để định dang cho mỗi một thiết bị cài đặt Hosted App. Device id tốt nên không thay đổi cho từng device, kể cả sau khi người dùng xoá Hosted App đi và cài lại.

login

Hàm này được sử dụng để cài đặt hàm getUser

async function login(): User | null

Kiểu User được mô tả như trong API getUser

getLocation

Hàm này được sử dụng để cài đặt hàm getLocation

async function getLocation(): Location | null

Trong đó Location là một object có chứa các key

tên trường	kiểu dữ liệu	ý nghĩa
lat	float	latitude của người dùng
lng	float	longitude của người dùng

getAppDocumentsDirectory

Hàm này được sử dụng trong lúc build assets và trỏ vào images

Hàm này chỉ cần cài đặt trên Android và iOS Trên Web, chúng ta không cần phải cài đặt hàm này

function getAppDocumentsDirectory(): string

openMiniApp

Hàm này được sử dụng để cài đặt hàm openMiniApp

async function openMiniApp({ bundleURL: string, appId: string, page?: string, params?: object })

openHostedScreen

Hàm này được sử dụng để cài đặt hàm openHostedScreen

function openHostedScreen({ screen: string, params?: object })

loadWidget

Hàm này được sử dụng để cài đặt hàm renderWidget

async function loadWidget({ bundleURL: string, appId: string, name: string, params?: object })

openOrderDetail

Hàm này được sử dụng để cài đặt hàm order_detail

function openOrderDetail(id: string)