dlt.addToHomeScreen

Introduction

Add a shortcut for the mini-program to the home screen.

Usage Limitations

Supported in the basic library version 4.0.0 or higher.

Parameters

Object object

Property	Type	Default	Required	Description
success	function		No	Callback function for a successful API call.
fail	function		No	Callback function for a failed API call.
complete	function		No	Callback function for the completion of the API call (executed whether the call is successful or not).

object.success Callback Function

Parameters

Object res

Property	Type	Description
success	string	true - Setting successful.

object.fail Callback Function

Parameters

Object res

Property	Type	Description
success	string	false - Setting failed.

Sample Code

// pages/index/index.js
Page({
  addToHomeScreen() {
    dlt.addToHomeScreen({
      success: () => {
        console.log('success');
      },
    });
  },
});