@momo-platform/max-api NPM

Functions

copyToClipboard(text, toastMsg)

copy text to Clipboard and show toast.

Kind: global function

Param	Type	Description
text	text	text to save to Clipboard
toastMsg	text	text to show on Toast

openDialer(phone)

open Dialer to call.

Kind: global function

Param	Type	Description
phone	text	phone number

getBase64FromUrl(url, callback)

convert image from url to base64 string.

Kind: global function

Param	Type	Description
url	url	image url
callback	callback	callback base64 image

setBrightnessLevel(brightnessLevel, callback)

set Brightness level.

Kind: global function

Param	Type	Description
brightnessLevel	number	brightnessLevel 0 to 1
callback	callback	callback success or not

getBrightnessLevel(callback)

get Brightness level.

Kind: global function

Param	Type	Description
callback	callback	callback current brightness level

getSystemBrightnessLevel(callback)

get system Brightness level (Android only).

Kind: global function

Param	Type	Description
callback	callback	callback current system brightness level

sendSMS(phone, content, callback)

show SMS activity.

Kind: global function

Param	Type	Description
phone	number	phone number
content	text	sms content
callback	callback	callback empty

getScreenShot(callback)

capture screenshot

Kind: global function

Param	Type	Description
callback	callback	callback base64 of screenshot

enableScreenshots(enable)

enable screenshot (Android only).

Kind: global function

Param	Type	Description
enable	boolean	enable screenshot

getIpAddress(callback)

get Ip Address

Kind: global function

Param	Type	Description
callback	callback	callback ip-adress

getImage(options, callback)

Get image from gallery or capture new image

Kind: global function

Param	Type	Description
options	Object	options: {type: "camera"		"album", editable: true/false}
callback	callback

saveImage(base64Image, callback)

save image to gallery

Kind: global function

Param	Type
base64Image	string
callback	callback

getImageSize(uri, callback)

get size image

Kind: global function

Param	Type
uri	string
callback	callback

getImageRotateFromUri(uri, callback)

get rotated image from uri, return back uri

Kind: global function

Param	Type
uri	string
callback	callback

openURLWithPackageId(callbackDeepLink, packageId)

Open url with package id

Kind: global function

Param	Type
callbackDeepLink	callback
packageId	string

openURL(callbackDeepLink)

open url

Kind: global function

Param	Type
callbackDeepLink	callback

playYouTube(video:, callbackDeepLink)

playYouTube

Kind: global function

Param	Type	Description
video:	Object	{videoId: VideoId, videoURL: videoUrl}
callbackDeepLink	callback

trackEvent(event, parameters)

tracking event

Kind: global function

Param	Type	Description
event	String	tracking event name
parameters	Object	tracking parameters

trackPurchase(value)

tracking purchase

Kind: global function

Param	Type	Description
value	String	string of double value

shareFacebook(params)

share Facebook

Kind: global function

Param	Type	Description
params	Object	{link: link to share, image: share image, stories: {}}

throwJSException(exception, callback)

throwException throw Exception from miniApp at version 1.0

Kind: global function

Param	Type
exception	*
callback	*

uploadImage(imageData, callback)

Get image from gallery or capture new image

Kind: global function

Param	Type	Description
imageData	Object	imageData: {data: "base64 string", ext: "png", folder: "chat_images"}
callback	callback

share(data, callback)

share text content to other apps

Kind: global function

Param	Type
data	*
callback	*

setBadgeFeature(params, callback)

Get image from gallery or capture new image

Kind: global function

Param	Type	Description
params	Object	params: {badge: "string or number", featureCode: ""}
callback	callback

getDeviceInfo(callback)

Get device information

Kind: global function

Param	Type
callback	callback

openDeviceSetting(callback)

Open Device Setting

Kind: global function

Param	Type
callback	callback

isHighPerformanceDevice(callback)

Check device is high performance

Kind: global function

Param	Type
callback	callback

registerShakeSensitivity()

Kind: global function

unregisterShakeSensitivity()

unregister device shaking listener.

Kind: global function

saveCalendarEvent(title, details, options) ⇒

Creates or updates a calendar event. To update an event, the event id must be defined.

Kind: global function Returns: - Promise resolving to saved event's ID.

Param	Description
title	The title of the event
details	Event details
options	Options specific to the saved event.

sendExtraMessage(data, callback)

Handle API need to use base64 , must handle on Platform to avoid performance issue

Kind: global function

Param	Type	Description
data	data	data for request
callback	callback	callback

activeKeepAwake(isActive)

activeKeepAwake

Kind: global function

Param	Description
isActive	The title of the event

requestLogout(callback)

Request logout

Kind: global function

Param	Type
callback	*

getConfig(config, callback)

get Config.

Kind: global function

Param	Type	Description
config	text	config
callback	callback	return config

getContacts(options, callback)

get contacts.

Kind: global function

Param	Type	Description
options	Object	options
callback	callback	return array contacts

getContactInfo(phone, callback)

get contact info from phoneNumber.

Kind: global function

Param	Type	Description
phone	text	phone
callback	callback	return phone info

getContact(options, callback)

get contact from realm

Kind: global function

Param	Type	Description
options	Object	options : {phone, name}
callback	callback

queryContact(options, callback)

query contacts by options

Kind: global function

Param	Type
options	object
callback	callback

saveContact(contact, callback)

Save contact

Kind: global function

Param	Type	Description
contact	object	{phone, name}
callback	callback	return {isSaveSuccess, contact}

mapContacts(contacts, callback)

get list contact from realm from list contact

Kind: global function

Param	Type	Description
contacts	Array
callback	callback	return array contacts

pickSingleDocument(options, callback)

Pick single document (PDF, ...)

Kind: global function

Param	Type	Description
options	options	DocumentPickerOptions (please check react-native-document-picker documentation)
callback	callback	{data: DocumentPickerResponse, error: Error} if err.description === 'cancelled', request has been cancelled by user

uploadDocuments(options, callback)

Upload documents

Kind: global function

Param	Type	Description
options	options	UploadFileOptions (please check react-native-fs documentation and do not use begin & progress in the options).
callback	callback	{data: UploadResult, error: Error} if err.description === 'cancelled', request has been cancelled by user

startCaptureSideDocument(config, callback)

Start camera to capture front/back of document

Kind: global function

Param	Type	Description
config	config	config apply for UI
callback	callback	callback

startCaptureFace(config, callback)

Start camera to capture face

Kind: global function

Param	Type	Description
config	config	config apply for UI
callback	callback	callback

faceMatching(config, callback)

Compare face between document picture and selfie picture

Kind: global function

Param	Type	Description
config	config	api parammeter
callback	callback	callback

getAvatarEndPoint(callback)

get endpoint url of contact.

Kind: global function

Param	Type	Description
callback	callback	return endpoint url of contact

getResourceEndpoint(callback)

get resource endpoint .

Kind: global function

Param	Type	Description
callback	callback	return resource endpoint

getSteps(params, startDate, endDate)

get steps of user.

Kind: global function

Param	Type	Description
params	object	params
startDate
endDate
	callback	return data when it be triggered

listen(eventName, callback)

listen all events

Kind: global function

Param	Type
eventName	string
callback	callback

requestLocation(params, callback)

request location of device.

Kind: global function

Param	Type	Description
params	object	params {permission: Location Type}
callback	callback	return location of device

requestLocationWithOptions(params, options, callback)

request location of device.

Kind: global function

Param	Type	Description
params	object	params {permission: Location Type}
options	options	options {option: Location Options}
callback	callback	return location of device

getLocation(callback)

get location of device.

Kind: global function

Param	Type	Description
callback	callback	return location of device

connectMqttBroker(options, callback)

connect client to MQTT Broker over websocket

Kind: global function

Param	Type	Description
options	object	connect options : { timeout: "number", userName: "string", password: "string", willMessage: "object", keepAliveInterval: "number", cleanSession: "boolean", useSSL: "boolean", invocationContext: "object", hosts: "object", ports: "object", reconnect: "boolean", mqttVersion: "number", mqttVersionExplicit: "boolean", uris: "object" }
callback	callback	callback when connection status change

disconnectMqttBroker()

Disconnect client to MQTT Broker

Kind: global function

subscribeMqttTopic(topic, subscribeOptions, callback)

subscribe a topic

Kind: global function

Param	Type	Description
topic	string	topic of publisher
subscribeOptions	object	subscribe options : { qos: "number", invocationContext: "object", timeout: "number" }
callback	callback	callback subscribe status

unsubscribeMqttTopic(topic, unsubscribeOptions, callback)

unsubscribe a topic

Kind: global function

Param	Type	Description
topic	string	return connection status
unsubscribeOptions	object	unsubscribe options: { invocationContext: "object", timeout: "number" }
callback	callback	return connection status

fetchNetworkInfo(requestedInterface, requestedInterface)

fetch newest net info of device.

Kind: global function

Param	Type	Description
requestedInterface		requestedInterface
requestedInterface	callback	return net info of device

useNetInfo(callback)

get user net info of device.

Kind: global function

Param	Type	Description
callback	callback	return net info of device

sendMessage(props, callback)

send message to Backend.

Kind: global function

Param	Type	Description
props	object	request
callback	callback	return response

sendConfirmMessage(props, callback)

send message with confirmation pass to Backend.

Kind: global function

Param	Type	Description
props	object	request
callback	callback	return response

sendProxyMessage(props, callback)

send message to Proxy Backend (BE redirect message to others).

Kind: global function

Param	Type	Description
props	object	request
callback	callback	return response

sendCloudMessage(props, callback)

send message to Cloud.

Kind: global function

Param	Type	Description
props	object	request
callback	callback	return response

getCloudMessage(props, callback)

get data from Cloud.

Kind: global function

Param	Type	Description
props	object	request
callback	callback	return response

clickNotification(notification)

handle refId from notification

Kind: global function

Param	Type
notification	object

showPopupNotification(notification)

show popup

Kind: global function

Param	Type
notification	object

observer(schema, callback)

Kind: global function

Param	Type	Description
schema	text	schema
callback	callback	callback when meesage of schema be triggered

getDataObserver(schema, callback)

get data from observer storage

Kind: global function

Param	Type	Description
schema	text	schema
callback	callback	return data

setDataObserver(schema, data)

set data to observer storage

Kind: global function

Param	Type	Description
schema	text	schema
data	Object	data

getPassengerInfo(callback)

get profile.

Kind: global function

Param	Type	Description
callback	callback	return data

setPassengerInfo(profile)

set profile.

Kind: global function

Param	Type	Description
profile	array	{email:"", name:"", firstName:"", lastName:"",phone:"", personalId:"": address:"", birthDate:"", city= "", district= "", ward= "", gender: 1}

requestPayment(params, callback)

request payment

Kind: global function

Param	Type
params	object
callback	callback

requestPaymentSdk(params, callback)

request payment sdk

Kind: global function

Param	Type
params	object
callback	callback

countTrace(parameters, callback)

trace count event.

Kind: global function

Param	Type	Description
parameters	Object	parameters
parameters.flow	String	flow
parameters.step	String	step
callback	callback	({success: true	false, msg: null	"string"}})

startTrace(parameters, callback)

start trace event.

Kind: global function

Param	Type	Description
parameters	Object	parameters
parameters.flow	String	flow
parameters.step	String	step
callback	callback	({success: true	false, msg: null	"string"}})

stopTrace(traceId, parameters, callback)

stop trace event.

Kind: global function

Param	Type	Description
traceId	String	traceId: traceId when call startTrace
parameters	Object	parameters
parameters.flow	String	flow
parameters.step	String	step
callback	callback	({success: true	false, msg: null	"string"}})

errorTrace(parameters, callback)

trace error event.

Kind: global function

Param	Type	Description
parameters	Object	parameters
parameters.flow	String	flow
parameters.step	String	step
parameters.errorMessage	String	error message
parameters.errorCode	Number	error code
callback	callback	({success: true	false, msg: null	"string"}})

requestPermission(permission, callback)

request permission

Kind: global function

Param	Type
permission	string
callback	callback

checkPermission(permission, callback)

check permission has granted

Kind: global function

Param	Type
permission	string
callback	callback

scanQRCode(data, callback)

get data from qr code

Kind: global function

Param	Type
data	object
callback	callback

realmQuery(schema, query, sort, limit, callback)

query data from realm.

Kind: global function

Param	Type	Description
schema	text	schema
query	text	query
sort	array	sort
limit	number	limit number of object return
callback	callback	return value

realmSave(schema, object)

save data to realm.

Kind: global function

Param	Type	Description
schema	text	schema
object	object	object

realmDelete(schema, query)

delete data of realm.

Kind: global function

Param	Type	Description
schema	text	schema
query	text	query

navigate(routeName, params, callback)

navigate to other screen

Kind: global function

Param	Type
routeName	text
params	object
callback	callback

startApp(application, params, callback)

start other screen.

Kind: global function

Param	Type	Description
application	text	application
params	object	params
callback	callback	callback

startMiniApp(miniApp, params, callback)

start mini app.

Kind: global function

Param	Type	Description
miniApp	text	miniApp
params	object	params
callback	callback	callback

startService(service, params, callback)

start screen by service.

Kind: global function

Param	Type	Description
service	object	service
params	object	params
callback	callback	callback

startServiceId(serviceId, params, callback)

start screen by service id.

Kind: global function

Param	Type	Description
serviceId	object	serviceId
params	object	params
callback	callback	callback

startFeature(feature, params, callback)

start screen by feature.

Kind: global function

Param	Type	Description
feature	object	feature
params	object	params
callback	callback	callback function

startFeatureCode(featureCode, params, callback)

start screen by feature code.

Kind: global function

Param	Type	Description
featureCode	object	featureId
params	object	params
callback	callback	callback

openWeb(params, callback)

start web screen by url or html.

Kind: global function

Param	Type	Description
params	object	{url, html, title}
callback	callback	callback

dismiss(result, callback)

dismiss current screen and return result for previous route

Kind: global function

Param	Type	Description
result	object	result
callback	callback	callback

dismissAll(callback)

dismiss all screen.

Kind: global function

Param	Type	Description
callback	callback	callback

goBack(callback)

go back.

Kind: global function

Param	Type	Description
callback	callback	callback

goHome(callback)

go home screen.

Kind: global function

Param	Type	Description
callback	callback	callback

navigateTab(params, callback)

navigate to Tab index.

Kind: global function

Param	Type	Description
params	object	{index}
callback	callback	callback

getListFriendMoMo(contact, callback)

get List Friend MoMo

Kind: global function

Param	Type	Description
contact	object	{loading}
callback	callback	return response

getRelationShipStatus(contact, callback)

get RelationShip Status

Kind: global function

Param	Type	Description
contact	object	{loading,friendId}
callback	callback	return response

acceptFriendRequest(contact, callback)

accept Friend Request

Kind: global function

Param	Type	Description
contact	object	{loading,friendId}
callback	callback	return response

sendFriendRequest(contact, callback)

send Friend Request

Kind: global function

Param	Type	Description
contact	object	{loading,friendId}
callback	callback	return response

blockUser(contact, callback)

block User

Kind: global function

Param	Type	Description
contact	object	{loading,friendId}
callback	callback	return response

unBlockUser(contact, callback)

unBlock User

Kind: global function

Param	Type	Description
contact	object	{loading,friendId}
callback	callback	return response

getItem(key, callback)

get data from Storage.

Kind: global function

Param	Type	Description
key	text	key
callback	callback	return value

setItem(key, value)

set data to Storage.

Kind: global function

Param	Type	Description
key	text	key
value	text	value

removeItem(key)

remove data from Storage.

Kind: global function

Param	Type	Description
key	text	key

requestSync(type, callback)

request to sync

Kind: global function

Param	Type	Description
type	text	SERVICE, CARD, PROVIDER, POINT, BILL, CONTACT
callback	callback

getTransactionWithServiceIds(callback)

get transaction information.

Kind: global function

Param	Type	Description
	array	array of service ids
callback	callback	return array of transaction history of serviceids

getTransactionInfo(tranHisList, callback)

get transaction information.

Kind: global function

Param	Type	Description
tranHisList	array	array tranHis
callback	callback	array of transaction history

getTransactionStatusCode(params, callback)

get transaction status code.

Kind: global function

Param	Type	Description
params	text	tranType
callback	number	errorCode
	number	status
	callback	status code of transaction

getStatusInfo(statusCode, callback)

get transaction status information.

Kind: global function

Param	Type	Description
statusCode	text	statusCode
callback	callback	status information

getAllTransactionStatusInfo(callback)

get all transaction status information.

Kind: global function

Param	Type	Description
callback	callback	all status information

getAllTransactionStatusCode(callback)

get all transaction status code.

Kind: global function

Param	Type	Description
callback	callback	all status code

getMoneySourceName(tranHis, callback)

get money source name.

Kind: global function

Param	Type	Description
tranHis	tranHis	tranHis object
callback	callback	return name of money source

getFeatureById(featureId, callback)

Get feature by feature id

Kind: global function

Param	Type
featureId	*
callback	*

startTranHisDetail(params, onResult)

Start transaction history detail feature

Kind: global function

Param	Type	Description
params	*	S
onResult	*

showToast(...args)

show Toast.

Kind: global function

Param	Type	Description
...args	array	args

hideToast(...args)

hide Toast.

Kind: global function

Param	Type	Description
...args	array	args

showLoading(...args)

show Loading.

Kind: global function

Param	Type	Description
...args	array	args

hideLoading(...args)

hide Loading.

Kind: global function

Param	Type	Description
...args	array	args

showAlert(title, message, buttonTitles, callback)

show dialog alert.

Kind: global function

Param	Type	Description
title	text	title
message	text	message
buttonTitles	array	buttonTitles
callback	callback	return index of CTAs of dialog which be clicked

showAction(title, buttonTitles, callback)

show bottomsheet to choose action.

Kind: global function

Param	Type	Description
title	text	title
buttonTitles	array	buttonTitles
callback	callback	return index of CTAs of bottomSheet which be clicked

showPicker(args, callback)

show bottomsheet to choose action.

Kind: global function

Param	Type	Description
args	object	args
callback	callback	callback

getProfile(callback)

get user profile.

Kind: global function

Param	Type	Description
callback	callback	return data

requestUserInfo(options, callback)

request user info.

Kind: global function

Param	Type	Description
options	object	options
callback	callback	return user info

setProfile(profile, callback)

set user profile.

Kind: global function

Param	Type	Description
profile	object	profile
callback	callback	return data

observerProfile(callback)

Kind: global function

Param	Type	Description
callback	callback	return data when it be triggered

setUserProfileExtraOnServer(callback)

set profile extra.

Kind: global function

Param	Type	Description
	text	key
callback	object	val
	callback	return data when it be triggered

updateItemServer(data, data)

update item to backend

Kind: global function

Param	Type	Description
data	array	{type:'abc', key: key1, value: value1}, {type:'abc2', key: key2, value: value2}
data	object

updateItemLocal(data, data)

update item to realm

Kind: global function

Param	Type
data	array
data	object

getItemsServer(types)

get item from BE

Kind: global function

Param	Type
types	array

getItemsLocal(param)

get local item from realm

Kind: global function

Param	Type	Description
param	object	{type, keys: []}

getItemLocal(param)

get local item - user settings

Kind: global function

Param	Type	Description
param	object	{type, key}

observerUploadDocuments(param)

Upload documents with progress monitoring

Kind: global function

Param	Type	Description
param	object	{type, key}

cancelUpload(param)

Cancel uploading progress

Kind: global function

Param	Type	Description
param	object	{type, key}

setBackgroundTimeout(param)

Kind: global function

Param	Type	Description
param	object	{type, key}

getFullListFriendMoMo(param)

Kind: global function

Param	Type	Description
param	object	{type, key}

friendQuery(param)

Kind: global function

Param	Type	Description
param	object	{type, key}

syncContacts(param)

Kind: global function

Param	Type	Description
param	object	{type, key}

syncContactAfter1Day(param)

Kind: global function

Param	Type	Description
param	object	{type, key}

syncContactAfter1Minute(param)

Kind: global function

Param	Type	Description
param	object	{type, key}

getUserUUID(partnerCode, callback)

get userId by partnerCode

Kind: global function

Param	Type
partnerCode	string
callback	callback(userId: string)

setFastLogin(params, callback)

Enable fast login

Kind: global function

Param	Type
params	object	{value, loading}
callback	callback	return {status, response}

showToolkit(params)

Show tool kit

Kind: global function

Param	Type	Description
param	object	{type, key}

sendUploadMessage(props, callback)

Request upload files message.

Kind: global function

Param	Type	Description
props	object	{ path: "String", options: "Object", body: { is_avatar: "Boolean", is_private: "Boolean", files: "Array" or "Object" }}
callback	callback	return { status: "Boolean", response: "Object"}