Methods
The following shows the methods provided by the Wepin widget JavaScript SDK.
openWidget
openWidget
The openWidget
method shows the Wepin widget. The screen displayed in the widget window varies depending on the user's login status. If a user is not logged in, the Wepin widget will show them the login page.
Returned value
Promise
<void>
closeWidget
closeWidget
The closeWidget
method closes Wepin widget. Closing the window does not log users out.
getAccounts
getAccounts
or
The getAccounts
method returns user accounts of the networks available in the app. It's a method available after the widget login. The parameters are as follows.
Parameters
networks
: Array of string It is thenetwork
of the address you want to receive. If nonetwork
is specified, all addresses available in the app are returned. The names of blockchain networks that can be put intonetworks
can be found on the following page.
Returned Value
Promise
<Array>If a user is logged in, it returns a
Promise
object resolved with array ofaccount
of networks.Type of
account
is assigned at@wepin/types
asIAccount
account
Stringaddress
Stringnetwork
Stringcontract
String optionaltoken contract address. (
@wepin/types
(0.0.12 버전 이상)IAccount
에 정의되어 있습니다. )
If
networks
aren't passed, it returns aPromise
object resolved with array ofaccount
of all networks.Example
Promise
<void>If user is not logged in, it returns
Promise
.
getStatus
(Supported from version 0.3.1
and above.)
getStatus
(Supported from version 0.3.1
and above.)The getStatus()
method returns lifecycle of wepin
.
Returned Value
<WepinLifeCycle>
The
WepinLifeCycle
is defined at@wepin/types
as (Supports version 0.0.7 and above.)not_initialized
: ifwepin
is not initializedinitializing
: ifwepin
is initializinginitialized
: ifwepin
is initializedbefore_login
: ifwepin
is initialized but the user is not logged inlogin
: if the user is logged in
login
(Supported from version 0.3.1
and above.)
login
(Supported from version 0.3.1
and above.)The login()
method returns information of the logged-in user. If a user is not logged in, Wepin widget will show login page.
Returned Value
Promise
<IWepinUser>
Type of
IWepinUser
is defined in@wepin/types
(Supported from version0.0.7
and above.)status
String <'success'|'fail'>userInfo
Object (optional)userId
Stringemail
Stringprovider
String <'google'|'apple'>
Example
logout
(Supported from version 0.3.1
and above.)
logout
(Supported from version 0.3.1
and above.)The logout()
method performs a wepin
logout .
Returned Value
Promise
<void>
finalize
(Supported from version 0.3.1
and above.)
finalize
(Supported from version 0.3.1
and above.)The finalize()
method finalizes the Wepin SDK. The state of wepin
changes to not_initialized
.
Returned Value
void
loginWithExternalToken
(Supported from version 0.5.1
and above.)
loginWithExternalToken
(Supported from version 0.5.1
and above.)It logs in to the Wepin with external token(e.g., idToken
). The loginWithExternalToken()
method returns information of the logged-in user.
If the user is not registered on Wepin, and the withUI
value is set to true, the registration page will be displayed in the widget. However, if the withUI
value is set to false or not defined, a require/wepin-register
exception will be triggered.
Parameters
token
<string>External token value to be used for login (e.g., idToken).
sign
<string>Signature value for the token provided as the first parameter. (Signature Generation Methods)
The key for signing can be obtained from Wepin Workspace. In the Development Tools menu, click Get your authentication key on the Login tab to retrieve the authentication key.
withUI
<boolean> optionalIndicates whether to display the Wepin widget screen if registration is required.
Returned Value
Promise
<IWepinUser>Type of
IWepinUser
is defined in@wepin/types
(Supports version0.0.7
and above.)status
<'success'|'fail'>userInfo
<object> optionaluserId
<string>email
<string>provider
<'external_token'>
Example
require/wepin-register
: If this error occurs, you have to perform thewepin.register(pin)
method.
signUpWithEmailAndPassword
(Supported from version 0.5.1
and above.)
signUpWithEmailAndPassword
(Supported from version 0.5.1
and above.)It signs up on the Wepin with your email and password.
Parameters
email
<string> - User emailpassword
<string> - User password
Returned Value
Promise
<boolean>Returns true if the signup is successful.
Example
loginWithEmailAndPassword
(Supported from version 0.5.1
and above.)
loginWithEmailAndPassword
(Supported from version 0.5.1
and above.)It logs in to the Wepin with your email and password.
Parameters
email
<string> - User emailpassword
<string> - User password
Returned Value
Promise
<IWepinUser>Type of
IWepinUser
is defined in@wepin/types
(Supported from version0.0.8
and above.)status
<'success'|'fail'>userInfo
<object> optionaluserId
<string>email
<string>provider
<'email'>
Example
require/wepin-register
: If this error occurs, you have to perform thewepin.register(pin)
method.
register
(Supported from version 0.5.1
and above.)
register
(Supported from version 0.5.1
and above.)It registers in the Wepin with a wallet pin.
After the signup and login are completed, the Wepin service registration (wallet and account creation) will proceed.
Parameters
pin
<string> - Wallet PIN
Returned Value
Promise
<boolean>Returns true if the registration is successful.
After successful registration, the
wepin.login(email, password)
method has to be performed again.
getBalance
(Supported from version 0.5.1
and above.)
getBalance
(Supported from version 0.5.1
and above.)It returns the account balance information. It can be only usable after logging in through the widget.
Parameters
account
<IAccount
> - User emailType of
IAccount
is defined in@wepin/types
Returned Value
Promise
<IAccountBalance
>Type of
IAccountBalance
andITokenBalance
is defined in@wepin/types
(Supported from version0.0.8
and above.)symbol
<string> - symbol of the accountbalance
<string> - balance of the accounttokens
<Array<ITokenBalance
>> - token balance information for the accountname
<string> - token namecontract
<string> - token contract addresssymbol
<string> - token symbolbalance
<string> - token balance
Example
send
(Supported from version 0.5.3
and above.)
send
(Supported from version 0.5.3
and above.)The "send" is performed using the widget, and returns the ID information of the "send" transaction. It can only be used after logging into Wepin.
Parameters
account
<IAccount
> - User emailType of
IAccount
is defined in@wepin/types
options
<ISendOptions
> - The information required for the "send".The
ISendOptions
is defined at@wepin/types
.toAddress
<string
> - The address to send tokensamount
<string
> - The amount of tokens to send (in network units)
Example
Return Value
Promise
<string
>txID (Transaction ID) of the "send" transaction
Example
Exceptions
The error message types of the admin method are as follows.
Last updated