Structures

completionHandler (searchAppsByKeywords)

Parameter

Data type

Required

Description

result

NSDictionary<NSString *,id>

No

The search result. Provided if the query is successful. The value is a dictionary that includes the following keys:

  • appInfos:NSArrayRequired An array of mini programs that match the query.
  • hasMore:BOOLRequired Indicates whether more results are available. Valid values are:
    • YES: More results are available.
    • NO: No more results.

error

NSError

No

The error details. Provided if the query fails.

completionHandler (fetchLaunchableGroups) (Deprecated)

Parameter

Data type

Required

Description

groups

NSDictionary<NSString *,IAPLaunchableGroup *>

No

The section details. The parameter value is a dictionary where each key is a section code from the codes request parameter, and the value is an IAPLaunchableGroup object that provides the corresponding section details.

error

NSError

No

The error details. Provided if the request fails.

IAPLaunchableGroup (Deprecated)

Parameter

Data type

Required

Description

code

NSString

Yes

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

displayName

NSString

Yes

The section name displayed to users.

launchableItems

NSArray<IAPLaunchableItem *>

No

A list of mini programs in the section.

launchableGroups

NSArray<IAPLaunchableGroup *>

No

A list of sub-sections under this section.

IAPIAPLaunchableItem

Parameter

Data type

Required

Description

type

NSString

Yes

The type of the mini program.

IAPOperationFetchLaunchableGroupsParams

Parameter

Data type

Required

Description

useCache

BOOL

No

Indicates whether to use cache first:

  • true: Retrieve data from the cache first. If cache retrieval fails, then retrieve from the server.
  • false: This is the default value. Directly retrieve data from the server.

codes

NSArray<NSString *> *)


Yes

An array of unique codes that are assigned by Mini Program Platform to identify mini service sections.

queryScope

String

No

Indicates the scope of the mini program list to query. Valid values:

  • IAPOperationQueryScopeAll:Query all mini programs.
  • IAPOperationQueryScopeHomePage:Query the mini programs in the homepage only.

completionHandler (fetchLaunchableGroups)

Parameter

Data type

Required

Description

groups

NSDictionary<NSString *,IAPLaunchableGroup *>

No

The section details. The parameter value is a dictionary where each key is a section code from the codes request parameter, and the value is an IAPLaunchableGroup object that provides the corresponding section details.

error

NSError

No

The error details. Provided if the request fails.

IAPLaunchableGroup

Parameter

Data type

Required

Description

code

NSString

Yes

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

displayName

NSString

Yes

The section name displayed to users.

launchableItems

NSArray<IAPLaunchableItem *>

No

A list of mini programs in the section.

launchableGroups

NSArray<IAPLaunchableGroup *>

No

A list of sub-sections under this section.

viewAllStatus

String

NO

Indicates the status of the viewAll function (button). Valid values:

  • HIDDEN: Does not have the viewAll function.
  • DISABLED: The viewAll function is disabled.
  • ENABLED: The viewAll function is available to use.