Catalog Functions

DỮ LIỆU NGƯỜI DÙNG

requestUserConsents(options, callback)

1. Giới thiệu tính năng

Yêu cầu truy cập vào thông tin người dùng. Màn hình sẽ hiện một bottom drawer để yêu cầu được cung cấp thông tin.

Để sử dụng tính năng này, vui lòng đọc thêm tài liệu về Yêu cầu cấp quyền

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
options	object	CÓ	Object với trường “permissions” là một mảng chứa các quyền cần chia sẻ
callback	function	CÓ	Hàm callback với dữ liệu trả từ request

Options object

Trường	Loại data	Bắt buộc	Mô tả
permissions	array	CÓ	Mảng chứa các object quyền cần được cấp

Permission object

Trường	Loại data	Bắt buộc	Mô tả	Giá trị
role	string	CÓ	Tên quyền vai trò	"address" \| "addressKyc" \| "city" \| "countryCode" \| "countryName" \| "currentAddress" \| "deviceName" \| "deviceOs" \| "dobKyc" \| "email" \| "fullNameKyc" \| "gender" \| "genderKyc" \| "loyaltyPoints" \| "maritalStatus" \| "microShop" \| "name" \| "nationality" \| "nationalityKyc" \| "nickname" \| "phone" \| "preferedLanguage" \| "professional"
required	boolean	KHÔNG	Thiết lập các quyền yêu cầu chia sẻ dữ liệu người dùng trở thành bắt buộc	true \| false

Response

Params	Loại data	Mô tả
data	object	Dữ liệu người dùng
status	object	Trạng thái của các quyền đã yêu cầu

3. Request & response mẫu

Request

MiniApi.requestUserConsents({
    “permissions”: [
        {
            "role": “name”,
            "require": true
        },
        {
            "role": “phone”
        },
        {
            "role": “email”,
        },
        {
            "role": “gender”
        },
        {
            "role": “dateOfBirth”,
        },
        {
            "role": “identify”
        },
    ]
}, (data) => {
    console.log(data)
})

Response

// Trường hợp 1: Người dùng chấp nhận chia sẻ quyền
{
    "data": {
        "name": "John Doe",
        "phone": "09xxxxxxxx"
    },
    "status": {
        "email": "denied",
        "name": "granted",
        "phone": "granted"
    }
}

// Trường hợp 2: Người dùng huỷ chia sẻ quyền
{
    "data" : {}
    "status" : "cancelled"
}

// Trường hợp 3: AppId truyền vào không có quyền xin chia sẻ dữ liệu từ người dùng / Sai AppId. Truy cập trang developers.momoapp.vn để xin quyền sử dụng
{
    "data" : {},
    "status" : {}
}

4. Mã lỗi và các trường hợp đặc biệt

Mã lỗi	Miêu tả
-1	không được cấp quyền

getUserConsents(options, callback)

1. Giới thiệu tính năng

Truy cập thông tin người dùng đã được cấp quyền. Dữ liệu sẽ được trả qua callback

Để sử dụng tính năng này, vui lòng đọc thêm tài liệu về Yêu cầu cấp quyền

2. Các request và response params

Request

Params	Loại data	Required	Description
options	object	CÓ	Object với trường “permissions” là một mảng chứa các quyền cần chia sẻ
callback	function	CÓ	Hàm callback với dữ liệu trả từ request

Options object

Trường	Loại data	Bắt buộc	Mô tả
permissions	array	CÓ	Mảng chứa các object quyền cần được cấp

Permission object

Trường	Loại data	Bắt buộc	Mô tả	Giá trị
role	string	CÓ	Tên quyền vai trò	"address" \| "addressKyc" \| "city" \| "countryCode" \| "countryName" \| "currentAddress" \| "deviceName" \| "deviceOs" \| "dobKyc" \| "email" \| "fullNameKyc" \| "gender" \| "genderKyc" \| "loyaltyPoints" \| "maritalStatus" \| "microShop" \| "name" \| "nationality" \| "nationalityKyc" \| "nickname" \| "phone" \| "preferedLanguage" \| "professional"

Response

Params	Loại data	Mô tả
data	object	Dữ liệu người dùng
status	object	Trạng thái của các quyền đã yêu cầu

3. Request & response mẫu

Request

MiniApi.getUserConsents({
    “permissions”: [
        {
            "role": “name”,
        },
        {
            "role": “phone”
        },
        {
            "role": “email”,
        },
    ]
}, (data) => {
    console.log(data)
})

Response

{
    "data": {
        "name": "John Doe",
        "phone": "09xxxxxxxx"
    },
    "status": {
        "email": "denied",
        "name": "granted",
        "phone": "granted"
    }
}

4. Mã lỗi và các trường hợp đặc biệt

Mã lỗi	Miêu tả
-1	không được cấp quyền

getUserAuth(callback)

1. Giới thiệu tính năng

Lấy thông tin User Authenication

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
callback	function		callback

Response

Params	Loại data	Mô tả
authCode	string	Mã auth
miniAppUserId	string	Id của người dùng Mini App
partnerUserId	string	Id của người dùng đối tác

3. Request & response mẫu

Request

MiniApi.getUserAuth(callback);

Response

{
  authCode: "eyJ...";
  miniAppUserId: "MRk...";
  partnerUserId: "MRv...";
}

ĐIỀU HƯỚNG

goHome(callback)

1. Giới thiệu tính năng

Trở về màn hình chính của điện thoại

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
callback	callback		callback

3. Request & response mẫu

Request

   MiniApi.goHome(callback);

Response

N/A

goBack(callback)

1. Giới thiệu tính năng

Điều hướng tới màn hình trước đó

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
callback	callback		callback

3. Request & response mẫu

Request

   MiniApi.goBack(callback);

Response

N/A

openURL(callbackDeeplink)

1. Giới thiệu tính năng

Mở web URL với deep link được callback

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
callbackDeepLink	callback		callback

3. Request & response mẫu

Request

MiniApi.openURL(callbackDeepLink);

Response

N/A

openWeb(params, callback)

1. Giới thiệu tính năng

Mở web URL

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
params	object		{url,html,title}
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.openWeb(
     {
       url: "https://www.google.com",
       title: "google"
     },
     callback
   );

Response

N/A

dismissAll(callback)

1. Giới thiệu tính năng

Tắt tất cả các màn hình

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.dismissAll(callback);

Response

N/A

dismiss(result, callback)

1. Giới thiệu tính năng

Tắt màn hình hiện tại và thể hiện đường dẫn của kết quả trước đó

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
result	object		result
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.dismiss({resultCode:”001”},callback);

Response

N/A

TIỆN ÍCH

copyToClipboard(text, toastMsg)

1. Giới thiệu tính năng

Copy chữ vào clipboard và hiện màn hình toast

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
text	string		text được lưu vào Clipboard
toastMsg	string		text hiển thị trên màn hình toast

3. Request & response mẫu

Request

MiniApi.copyToClipboard("Text to copyToClipboard","Text to show toast");

Response

N/A

share(data, callback)

1. Giới thiệu tính năng

Chia sẻ nội dung chữ tới các app khác

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
data
callback	callback		callback

3. Request & response mẫu

Request

  MiniApi.share("Text to share",callback);

Response

N/A

ĐÀM THOẠI

openDialer(phone)

1. Giới thiệu tính năng

Bật tính năng gọi điện

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
phone	text	CÓ	số điện thoại

3. Request & response mẫu

Request

MiniApi.openDialer("0xxxxxxxx");

Response

4. Mã lỗi và cách xử lí

Không được phép xuất hiện lỗi. Nếu nhập sai loại argument sẽ khiến app bị crash

HÌNH ẢNH

getBase64FromUrl(url, callback)

1. Giới thiệu tính năng

Chuyển đổi ảnh từ URL sang dạng string base64

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
url	string		url of image
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.getBase64FromUrl("https://example.png", (data) => {
        console.log(data);
 })

Response

Params	Loại data	Mô tả
data	string	Base64 string

4. Mã lỗi và cách xử lí

Không được phép xuất hiện lỗi. Nếu nhập sai loại argument sẽ khiến app bị crash

getImage(options, callback)

1. Giới thiệu tính năng

Lấy hình ảnh từ thư viện hoặc chụp hình mới

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
options	object		{type: "camera"/"album", editable: true/false}
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.getImage({
                type: "camera",
                editable: true
            }, (data) => {
                console.log(data);
            })

Response

Params	Loại data	Mô tả
data	string	string dạng Base64

saveImage(base64image, callback)

1. Giới thiệu tính năng

Lưu hình ảnh vào thư viện

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
base64Image	string
callback	callback

3. Request & response mẫu

Request

MiniApi.saveImage(data, (res) => {
                    console.log(res);
                })

Response

Params	Loại data	Mô tả
data	boolean	true nếu hình ảnh được lưu, false nếu các trường hợp khác

getImageSize(uri, callback)

1. Giới thiệu tính năng

Lấy số đo hình ảnh

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
uri	string	CÓ
callback	callback		callback

3. Request & response mẫu

N/A

LƯU TRỮ

getItem(key, callback)

1. Giới thiệu tính năng

Lấy dữ liệu từ nơi lưu trữ

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
key	string	CÓ	key
callback	callback		trả lại kết quả

3. Request & response mẫu

Request

MiniApi.getItem('API', (data) => {
                console.log(data);
 })

Response

Params	Loại data	Mô tả
data	string	value của key

setItem(key, value)

1. Giới thiệu tính năng

Đặt data vào nơi lưu trữ

2. Các request và response params

Params	Loại data	Bắt buộc	Mô tả
key	string	CÓ	key
value	string	CÓ	value

3. Request & response mẫu

Request

MiniApi.setItem(‘API’, ‘hello’)

Response void

removeItem(key)

1. Giới thiệu tính năng

Xóa dữ liệu khỏi nơi lưu trữ

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
key	string		key

3. Request & response mẫu

Request

MiniApi.removeItem(‘API’)

Response

void

QUYỀN TRUY CẬP

requestPermission(permission, callback)

1. Giới thiệu tính năng

Yêu cầu quyền truy cập trên thiết bị như máy ảnh, thư viện...

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
permission	string		“camera” \| “photo” \| “storage” \| “location” \| “contacts”
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.requestPermission('photo', (data) => {
               console.log(data);
           })

Response

Params	Loại data	Mô tả
data	string	‘granted’ nếu được cho phép, ‘denied’ nếu không, ‘unavailable’ nếu quyền đó không tồn tại

checkPermission(permission, callback)

1. Giới thiệu tính năng

Kiểm tra các quyền truy cập đã được cho phép sử dụng

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
permission	string		“camera” \| “photo” \| “storage” \| “location” \| “contacts”
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.checkPermission(‘camera’, (data) => {
    console.log(data);
})

Response

Params	Loại data	Mô tả
data	string	‘granted’ nếu được cho phép, ‘denied’ nếu không, ‘unavailable’ nếu quyền đó không tồn tại

VỊ TRÍ

getLocation(callback)

1. Giới thiệu tính năng

Lấy thông tin vị trí của thiết bị

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
callback	callback		trả về vị trí của thiết bị

3. Request & response mẫu

Request

MiniApi.getLocation((data) => {
    console.log(data);
})

Response

{
    "mocked": boolean,
    "timestamp": number,
    "coords": {
        "speed": number,
        "heading": number,
        "altitude": number,
        "accuracy": number,
        "longitude": float,
        "latitude": float
    }
}

Params	Loại data	Mô tả
data	object	(như trong code block trên)

MÁY ẢNH

scanQRCode(data, callback)

1. Giới thiệu tính năng

Lấy data từ mã QR

2. Các request và response params

Request

Params	Loại data	Bắt buộc	Mô tả
data	deeplink
callback	callback		callback

3. Request & response mẫu

Request

MiniApi.scanQRCode(data, (result) => {
    console.log(data);
})

Response

Params	Loại data	Mô tả
data	object	data trong deeplink

THÔNG ĐIỆP, Ô THOẠI

showToast(object)

1. Giới thiệu tính năng

Hiện màn hình Toast

2. Các request và response params

Request

Param	Type	Bắt buộc	Mô tả
object	object	có	Object chứa các truờng như description, type, và duration
description	string	có	Mô tả toast
type	string	có	Loại toast
duration	number	có	Thời gian hiện toast

Reponse

Hiển thị toast ở cuối màn hình

3. Request và response mẫu

Request

MiniApi.showToast({
      description: "Successfully",
      type: "success",
      duration: 2000
});

Response

hideToast()

1. Giới thiệu tính năng

Ẩn màn hình Toast

2. Các request và response params

3. Request và response mẫu

Request

MiniApi.hideToast();

showToastSuggestion(...args)

1. Giới thiệu tính năng

Hiển thị Suggestion toast

2. Request tính năng

Request

Params	Loại data	Bắt buộc	Mô tả
type	string	có	Loại của call-to-action. Value: share \| addFavorite \| addShortcut
duration	number	không	Thời lượng của Suggestion toast

3. Request & Respone mẫu

Request

MiniApi.showToastSuggestion({
           type: 'addShortcut',
           duration: 2000,
         },callback);

Responese

hideToastSuggestion()

1. Giới thiệu tính năng

Ẩn Suggestion toast

2. Request & Response mẫu

Request

MiniApi.hideToastSuggestion()

showAlert(title, message, buttonTitles, callback)

1. Giới thiệu tính năng

Hiện hộp thoại cảnh báo

2. Các request và response params

Request

Params	Loại data	Mô tả
title	string	tiêu đề
message	string	tin nhắn
buttonTitles	array	các tiêu đề nút
callback	callback	trả về index của các CTA của màn hộp thoại được ấn vào

3. Request & response mẫu

Request

 MiniApi.showAlert(
                "hello",
                "hello world",
                ["OK", "Cancel"],
                (data) => {
                    console.log(data);
                }
            )

Response

Params	Loại data	Mô tả
data	number	trả về 0 hoặc 1 dựa vào hành động được chọn

showAction(title, buttonTitles, callback)

1. Giới thiệu tính năng

Hiện bottom sheet và các tính năng bên trong

2. Các request và response params

Request

Params	Loại data	Mô tả
title	string	tiêu đề
buttonTitles	array	các tiêu đề nút
callback	callback	trả về index của các CTA trong bottomSheet mà được ấn vào

3. Request & response mẫu

Request

 MiniApi.showAction(
                "hello",
                ["OK", "Cancel"],
                (data) => {
                    console.log(data);
                }
            )

Response

Params	Loại data	Mô tả
data	number	trả về 0 hoặc 1 dựa vào hành động được chọn

GIAO DIỆN

showLoading()

1. Giới thiệu tính năng

show Loading

2. Các request và response params

3. Request & response mẫu

Request

MiniApi.showLoading()

Response

void

hideLoading()

1. Giới thiệu tính năng

Ẩn màn hình Loading

2. Các request và response params

3. Request & response mẫu

Request

MiniApi.hideLoading()

Response

void

Catalog Functions

DỮ LIỆU NGƯỜI DÙNG​

requestUserConsents(options, callback)​

getUserConsents(options, callback)​

getUserAuth(callback)​

ĐIỀU HƯỚNG​

goHome(callback)​

goBack(callback)​

openURL(callbackDeeplink)​

openWeb(params, callback)​

dismissAll(callback)​

dismiss(result, callback)​

TIỆN ÍCH​

copyToClipboard(text, toastMsg)​

share(data, callback)​

ĐÀM THOẠI​

openDialer(phone)​

HÌNH ẢNH​

getBase64FromUrl(url, callback)​

getImage(options, callback)​

saveImage(base64image, callback)​

getImageSize(uri, callback)​

LƯU TRỮ​

getItem(key, callback)​

setItem(key, value)​

removeItem(key)​

QUYỀN TRUY CẬP​

requestPermission(permission, callback)​

checkPermission(permission, callback)​

VỊ TRÍ​

getLocation(callback)​

MÁY ẢNH​

scanQRCode(data, callback)​

THÔNG ĐIỆP, Ô THOẠI​

showToast(object)​

hideToast()​

showToastSuggestion(...args)​

hideToastSuggestion()​

showAlert(title, message, buttonTitles, callback)​

showAction(title, buttonTitles, callback)​

GIAO DIỆN​

showLoading()​

hideLoading()​

DỮ LIỆU NGƯỜI DÙNG

requestUserConsents(options, callback)

getUserConsents(options, callback)

getUserAuth(callback)

ĐIỀU HƯỚNG

goHome(callback)

goBack(callback)

openURL(callbackDeeplink)

openWeb(params, callback)

dismissAll(callback)

dismiss(result, callback)

TIỆN ÍCH

copyToClipboard(text, toastMsg)

share(data, callback)

ĐÀM THOẠI

openDialer(phone)

HÌNH ẢNH

getBase64FromUrl(url, callback)

getImage(options, callback)

saveImage(base64image, callback)

getImageSize(uri, callback)

LƯU TRỮ

getItem(key, callback)

setItem(key, value)

removeItem(key)

QUYỀN TRUY CẬP

requestPermission(permission, callback)

checkPermission(permission, callback)

VỊ TRÍ

getLocation(callback)

MÁY ẢNH

scanQRCode(data, callback)

THÔNG ĐIỆP, Ô THOẠI

showToast(object)

hideToast()

showToastSuggestion(...args)

hideToastSuggestion()

showAlert(title, message, buttonTitles, callback)

showAction(title, buttonTitles, callback)

GIAO DIỆN

showLoading()

hideLoading()