Structures

FetchSearchAppsByKeywordCallBack

Method

Required

Description

onResponse

Yes

A method that is executed when the query is successful. Receives the query results via the result: SearchAppsResult parameter. For more information, refer to SearchAppsResult.

onFailure

Yes

A method that is executed when the query fails. Receives an error via the following parameters:

  • errorCode:IntRequired A numeric code that represents a specific error.
  • errorMessage:StringRequired The corresponding error message.

SearchAppsResult

Parameter

Data type

Required

Description

hasMore

Boolean

Yes

Indicates whether more results are available. Valid values are:

  • true: More results are available.
  • false: No more results.

apps

List<MiniProgramLaunchableItem>

Yes

A list of mini programs that match the query.

MiniProgramLaunchableItem

Parameter

Data type

Required

Description

identifier

String

Yes

The unique ID that is assigned by Mini Program Platform to identify a mini program.

introduction

String

Yes

The mini program description.

name

String

Yes

The mini program name.

slogan

String

Yes

The mini program tagline.

iconURL

String

Yes

The URL of the mini program logo.

releaseVersion

String

No

The release version of a mini program.

categories

List<LaunchableCategory>

Yes

The categories that the mini program belongs to.

isFavorite

Boolean

Yes

Indicates whether the mini program is favorited. Valid values are:

  • true: The mini program is favorited.
  • false: The mini program is not favorited.

lastUsedTimestamp

Long

Yes

The last time the mini program was used.

LaunchableCategory

Parameter

Data type

Required

Description

name

String

Yes

The category name.

identifier

String

Yes

The unique ID that is assigned by Mini Program Platform to identify the category.

FetchLaunchableGroupsCallback

Method

Required

Description

onResponse

Yes

A method that is executed when the request is successful. Receives the section details via the result: Map<String, LaunchableGroup> parameter. The parameter value is a list of key-value pairs. Each key is a section code from the codes request parameter, and the value is a LaunchableGroup object containing the section details.

onFailure

Yes

A method that is executed when the request fails. Receives an error via the following parameters:

  • errorCode:StringRequired A numeric code that represents a specific error.
  • errorMessage:StringRequired The corresponding error message.

For more information, refer to the Error codes section in the API specification.

LaunchableGroup

Parameter

Data type

Required

Description

code

String

Yes

Unique section identifier (matches the code provided in the request).

displayName

String

Yes

The section name displayed to users.

launchableItems

List<LaunchableItem>

No

A list of mini programs in the section.

launchableGroups

List<LaunchableGroup>

No

A list of sub-sections under this section.

LaunchableItem

Parameter

Data type

Required

Description

type

String

Yes

The type of the mini program.