setOpenId

2024-11-08 01:35

The setOpenId API is called by the super app to set the open ID, which is the user ID the super app returns in the memberInfoService SPI response. To retrieve and set the ID, you need to call this API after the IAPMiniProgram SDK has been initialized and the user logs in to the super app.

Method signature

copy
function setOpenId(
  openId: string,
  extra?: {
    success?: (success: BaseSuccess) => void;
    error?: (error: BaseError) => void;
  }
)

Request parameters

Field

Data type

Required

Description

openId

string

Yes

The unique ID that is assigned by the super app to identify a user. It corresponds to the value of the result.memberInfo.userId response parameter of the MemberInfoService SPI.

extra

Object

An extended attribute that is used to provide additional information if necessary. The included parameters are:

error: OptionalThe callback that is executed upon failure to set openId. When executed, it receives an instance of BaseError object. Specify this parameter if you need to handle the encountered errors.
success: OptionalThe callback that is executed upon successfully setting openId. When executed, it receives an instance of BaseSuccess object. Specify this parameter if you need to handle successful operations.

Response parameters

N/A

Result codes

Result code	Result message	Description	Further action
1000	`SUCCESS`	The SDK opens the mini program successfully.	N/A
2000	The result message varies depending on the error that occurs.	The SDK encounters an error when attempting to open the mini program.	Refer to the result message for specific actions.

Sample

copy

import { setOpenId } from 'iapminiprogram-rn';
import type { BaseSuccess, BaseError } from 'iapminiprogram-rn';
  
  function setMiniOpenId() {
    setOpenId('123xxx789', {
      success: (success: BaseSuccess) => {
  
      },
      error: (error: BaseError) => {
      
      },
    });
  }