Description:

wepin flutter login lib

wepin_flutter_login_lib #



Wepin Login Library from Flutter. This package is exclusively available for use in android and ios environments.
⏩ Get App ID and Key #
After signing up for Wepin Workspace, navigate to the development tools menu, and enter the required information for each app platform to receive your App ID and App Key.
⏩ Requirements #

Android API version 21 or newer is required.
iOS version 13 or newer is required.

Update the platform :ios version to 13.0 in the ios/Podfile of your Flutter project. Verify and modify the ios/Podfile as needed.


Dart version 2.18.3 or newer is required.
Flutter version 3.3.0 or newer is required.


Note
Due to potential multidex issues, it is recommended to use Android compiler SDK version 21 or higher.
Ensure that the minSdkVersion in your app's build.gradle file is set to 21 or higher[flutter document] :

build.gradle file minSdkVersion setting:
You should ensure the correct minSdkVersion is set in android/app/build.gradle if it was previously lower than 21:

android {
defaultConfig {
minSdkVersion 21
}
}
copied to clipboard

⏩ Install #
Add the wepin_flutter_login_lib dependency in your pubspec.yaml file:
dependencies:
wepin_flutter_login_lib: ^0.0.6
copied to clipboard
or run the following command:
flutter pub add wepin_flutter_login_lib
copied to clipboard
⏩ Getting Started #
Deep Link Setting #
The Deep Link configuration is required for logging into Wepin. Setting up the Deep Link Scheme allows your app to handle external URL calls.
The format for the Deep Link scheme is wepin. + Your Wepin App ID
Android
On Android, you can configure the Wepin Login Library to handle all redirects using a custom scheme by adding a manifest placeholder in the build.gradle (app) file::
// For Deep Link => RedirectScheme Format: wepin. + Wepin App ID
android.defaultConfig.manifestPlaceholders = [
'appAuthRedirectScheme': 'wepin.{{YOUR_WEPIN_APPID}}'
]
copied to clipboard
iOS
On iOS, you need to add the app's URL scheme to the Info.plist file. This is necessary to enable redirection back to the app after the authentication process.
The URL scheme value should be 'wepin.' + your Wepin App ID.
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>unique name</string>
<key>CFBundleURLSchemes</key>
<array>
<string>wepin.{{YOUR_WEPIN_APPID}}</string>
</array>
</dict>
</array>
copied to clipboard
OAuth Login Provider Setup #
If you want to use OAuth login functionality (e.g., loginWithOauthProvider), you need to set up OAuth login providers.
To do this, you must first register your OAuth login provider information in the Wepin Workspace.
Navigate to the Login tab under the Developer Tools menu, click the Add or Set Login Provider button in the Login Provider section, and complete the registration.


⏩ Import SDK #
import 'package:wepin_flutter_login_lib/wepin_flutter_login_lib.dart';
import 'package:wepin_flutter_login_lib/type/wepin_flutter_login_lib_type.dart';
copied to clipboard
⏩ Initialize #
WepinLogin wepinLogin = WepinLogin(wepinAppKey: wepinAppKey, wepinAppId: wepinAppId);
copied to clipboard
init #
await wepinLogin.init()
copied to clipboard
Parameters

None

Example
await wepinLogin.init();
copied to clipboard
isInitialized #
wepinLogin.isInitialized()
copied to clipboard
The isInitialized() method checks if the Wepin Login Library is initialized.
Returns

Future<bool> - Returns true if Wepin Login Library is already initialized, otherwise false.

⏩ Method #
Methods can be used after initializing the Wepin Login Library.
loginWithOauthProvider #
await wepinLogin.loginWithOauthProvider({required String provider, required String clientId})
copied to clipboard
An in-app browser will open and proceed to log in to the specified OAuth provider. Returns OAuth login info upon successful login.
Parameters

provider <String> - The OAuth login provider (e.g., 'google', 'naver', 'discord', 'apple').
clientId <String> - The client ID of the OAuth login provider.


Note
For details on setting up OAuth providers, refer to the OAuth Login Provider Setup section.

Returns

Future<LoginOauthResult>

provider <String> - The name of the OAuth provider used.
token <String> - The token returned by the OAuth provider.
type <WepinOauthTokenType> - The type of OAuth token (e.g., idToken, accessToken).



Exception

WepinError

Example
final user = await wepinLogin.loginWithOauthProvider(
provider: "google",
clientId: "your-google-client-id"
);
copied to clipboard

response

LoginOauthResult(
provider: "google",
token: "abcdefgh....adQssw5c",
type: WepinOauthTokenType.idToken
)
copied to clipboard
signUpWithEmailAndPassword #
await wepinLogin.signUpWithEmailAndPassword({required String email, required String password, String? locale})
copied to clipboard
This method signs up on Wepin Firebase with your email and password. It returns Firebase login information upon successful signup.
Parameters

email <String> - The user's email address.
password <String> - The user's password.
locale <String> - optional The language for the verification email (default: "en").

Returns

Future<LoginResult>

provider <String> - The provider used for the login (in this case, 'email').
token <WepinFBToken>

idToken <String> - The Wepin Firebase ID token.
refreshToken <String> -The Wepin Firebase refresh token.





Exception

WepinError

Example
final user = await wepinLogin.signUpWithEmailAndPassword(
email: 'abc@defg.com',
password: 'abcdef123&'
);
copied to clipboard

response

LoginResult(
provider: "email",
token: WepinFBToken(
idToken: "ab2231df....ad0f3291",
refreshToken: "eyJHGciO....adQssw5c",
)
)

copied to clipboard
loginWithEmailAndPassword #
await wepinLogin.loginWithEmailAndPassword({required String email, required String password})
copied to clipboard
This method logs in to Wepin Firebase with your email and password. It returns Firebase login information upon successful login.
Parameters

email <String> - The user's email address.
password <String> - The user's password.

Returns

Future<LoginResult>

provider <String> - The provider used for the login (in this case, 'email').
token <WepinFBToken>

idToken <String> - The Wepin Firebase ID token.
refreshToken ``





Exception

WepinError

Example
final user = await wepinLogin.loginWithEmailAndPassword(
email: 'abc@defg.com',
password: 'abcdef123&'
);

copied to clipboard

response

LoginResult(
provider: "email",
token: WepinFBToken(
idToken: "ab2231df....ad0f3291",
refreshToken: "eyJHGciO....adQssw5c",
)
)
copied to clipboard
loginWithIdToken #
await wepinLogin.loginWithIdToken({required String idToken, required String sign})
copied to clipboard
The loginWithIdToken() method logs in to Wepin Firebase using an external ID token. It returns Firebase login information upon successful login.
Parameters

idToken <String> - The ID token value to be used for login.
sign <String?> - optional The signature value for the token provided as the first parameter. (Returned value of getSignForLogin())


Note
Starting from wepin_flutter_login_lib version 0.0.5, the sign value is optional.
If you choose to remove the authentication key issued from the Wepin Workspace, you may opt not to use the sign value.
(Wepin Workspace > Development Tools menu > Login tab > Auth Key > Delete)

The Auth Key menu is visible only if an authentication key was previously generated.


Returns

Future<LoginResult>

provider <'external_token'> - The provider used for the login.
token <WepinFBToken>

idToken <String> - The Wepin Firebase ID token.
refreshToken <String> - The Wepin Firebase refresh token.





Exception

WepinError

Example
final user = await wepinLogin.loginWithIdToken(
idToken:'eyJHGciO....adQssw5c',
sign:'9753d4dc...c63466b9'
);
copied to clipboard

response

LoginResult(
provider: "external_token",
token: WepinFBToken(
idToken: "ab2231df....ad0f3291",
refreshToken: "eyJHGciO....adQssw5c",
)
)

copied to clipboard
loginWithAccessToken #
await wepinLogin.loginWithAccessToken({required String provider, required String accessToken, required String sign})
copied to clipboard
The loginWithAccessToken() method logs in to Wepin Firebase using an external access token. It returns Firebase login information upon successful login.
Parameters

provider <'naver'|'discord'> - The provider that issued the access token.
accessToken <String> - The access token value to be used for login.
sign <String?> - optional The signature value for the token provided as the first parameter. getSignForLogin())


Note
Starting from wepin_flutter_login_lib version 0.0.5, the sign value is optional.
If you choose to remove the authentication key issued from the Wepin Workspace, you may opt not to use the sign value.
(Wepin Workspace > Development Tools menu > Login tab > Auth Key > Delete)

The Auth Key menu is visible only if an authentication key was previously generated.


Returns

Future<LoginResult>

provider <'external_token'> - The provider used for the login.
token <WepinFBToken>

idToken <String> - The Wepin Firebase ID token.
refreshToken <String> - The Wepin Firebase refresh token.





Exception

WepinError

Example
final user = await wepinLogin.loginWithAccessToken(
provider: 'naver',
accessToken:'eyJHGciO....adQssw5c',
sign:'9753d4dc...c63466b9'
);
copied to clipboard

response

LoginResult(
provider: "external_token",
token: WepinFBToken(
idToken: "ab2231df....ad0f3291",
refreshToken: "eyJHGciO....adQssw5c",
)
)

copied to clipboard
getSignForLogin #
The getSignForLogin() method generates a signature to verify the issuer. It is primarily used to generate signatures for login-related information such as ID Tokens and Access Tokens.
final result = getSignForLogin({required String privateKey, required String message});
copied to clipboard
Parameters

privateKey <String> - The authentication key used for signature generation.
message <String> - The message or payload to be signed.

Returns

<String> - The generated signature.


Caution
The authentication key (privateKey) must be stored securely and must not be exposed to the outside. It is recommended to execute the getSignForLogin() method on the backend rather than the frontend for enhanced security and protection of sensitive information. How to Implement Direct Signature Generation Functions

Example
final sign = getSignForLogin(
privateKey: '0400112233445566778899001122334455667788990011223344556677889900',
message: 'idtokenabcdef'
);

final res = await wepinLogin.loginWithIdToken(
idToken: 'eyJHGciO....adQssw5c',
sign: sign
);
copied to clipboard
getRefreshFirebaseToken #
await wepinLogin.getRefreshFirebaseToken()
copied to clipboard
The getRefreshFirebaseToken() method retrieves the current Firebase token's information from Wepin.
Parameters

None

Returns

Future<LoginResult>

provider <String> - The provider used for the login.
token <WepinFBToken>

idToken <String> - The Wepin Firebase ID token.
refreshToken <String> -The Wepin Firebase refresh token.





Exception

WepinError


Example
final user = await wepinLogin.getRefreshFirebaseToken();
copied to clipboard

response

LoginResult(
provider: "external_token",
token: WepinFBToken(
idToken: "ab2231df....ad0f3291",
refreshToken: "eyJHGciO....adQssw5c",
)
)
copied to clipboard
loginWepin #
await wepinLogin.loginWepin(LoginResult params)
copied to clipboard
The loginWepin() method logs the user into the Wepin application using the specified provider and token.
Parameters

params <LoginResult> - The parameters should utilize the return values from the loginWithOauthProvider(), loginWithEmailAndPassword(), loginWithIdToken(), and loginWithAccessToken() methods within this module.

provider <'google'|'apple'|'naver'|'discord'|'external_token'|'email'> - The login provider.
token <WepinFBToken> - The login tokens.



Returns

Future<WepinUser> - A Future that resolves to a WepinUser object containing the user's login status and information.

status <'success'|'fail'> - The login status.
userInfo <WepinUserInfo> optional - The user's information, including:

userId <String> - The user's ID.
email <String> - The user's email.
provider <'google'|'apple'|'naver'|'discord'|'email'|'external_token'> - The login provider.
use2FA <bool> - Whether the user uses two-factor authentication.


walletId <String> = The user's wallet ID.
userStatus: <WepinUserStatus> - The user's status of wepin login. including:

loginStatus: <'complete' | 'pinRequired' | 'registerRequired'> - If the user's loginStatus value is not complete, the user must be registered in Wepin.
pinRequired?:


token: <WepinToken> - The user's token of wepin.

accessToken: <String> - The access token.
refreshToken <String> - The refresh token.





Exception

WepinError

Example
final wepinLogin = WepinLogin(appId: 'appId', appKey: 'appKey');
await wepinLogin.init();
final res = await wepinLogin.loginWithOauthProvider(
provider: "google",
clientId: "your-google-client-id"
);

final sign = wepinLogin?.getSignForLogin(privateKey: privateKey, message: res!.token);
LoginResult? resLogin;
if(provider == 'naver' || provider == 'discord') {
resLogin = await wepinLogin.loginWithAccessToken(provider: provider, accessToken: res!.token, sign: sign));
} else {
resLogin = await wepinLogin.loginWithIdToken(idToken: res!.token, sign: sign));
}

final userInfo = await wepinLogin.loginWepin(resLogin);
final userStatus = userInfo.userStatus;
if (userStatus.loginStatus == 'pinRequired' || userStatus.loginStatus == 'registerRequired') {
// Wepin register
}
copied to clipboard

response

WepinUser(
status: "success",
userInfo: WepinUserInfo(
userId: "120349034824234234",
email: "abc@gmail.com",
provider: "google",
use2FA: true,
),
walletId: "abcdsfsf123",
userStatus: WepinUserStatus(
loginStatus: "complete",
pinRequired: false,
),
token: WepinToken(
accessToken: "access_token",
refreshToken: "refresh_token",
)
)
copied to clipboard
getCurrentWepinUser #
await wepinLogin.getCurrentWepinUser()
copied to clipboard
The getCurrentWepinUser() method retrieves the currently logged-in user's information from Wepin.
Parameters

None

Exception

WepinError

Returns

Future<WepinUser> - A Future that resolves to a WepinUser object containing the user's login status and information.

status <'success'|'fail'> - The login status.
userInfo <WepinUserInfo> optional - The user's information, including:

userId <String> - The user's ID.
email <String> - The user's email.
provider <'google'|'apple'|'naver'|'discord'|'email'|'external_token'> - The login provider.
use2FA <bool> - Whether the user uses two-factor authentication.


walletId <String> = The user's wallet ID.
userStatus: <WepinUserStatus> - The user's status of wepin login. including:

loginStatus: <'complete' | 'pinRequired' | 'registerRequired'> - If the user's loginStatus value is not complete, it must be registered in the wepin.
pinRequired?:


token: <WepinToken> - The user's token of wepin.

accessToken: <String> - The access token.
refreshToken <String> - The refresh token.





Example
final userInfo = await wepinLogin.getCurrentWepinUser();
final userStatus = userInfo.userStatus;
if (userStatus.loginStatus == 'pinRequired' || userStatus.loginStatus == 'registerRequired') {
// Wepin register
}
copied to clipboard

response

WepinUser(
status: "success",
userInfo: WepinUserInfo(
userId: "120349034824234234",
email: "abc@gmail.com",
provider: "google",
use2FA: true,
),
walletId: "abcdsfsf123",
userStatus: WepinUserStatus(
loginStatus: "complete",
pinRequired: false,
),
token: WepinToken(
accessToken: "access_token",
refreshToken: "refresh_token",
)
)
copied to clipboard
loginFirebaseWithOauthProvider #
await wepinLogin.loginFirebaseWithOauthProvider({required String provider, required String clientId})
copied to clipboard
This method combines the functionality of loginWithOauthProvider, loginWithIdToken, and loginWithAccessToken.
It opens an in-app browser to log in to Wepin Firebase through the specified OAuth login provider. Upon successful login, it returns Firebase login information.

Caution
This method can only be used after the authentication key has been deleted from the Wepin Workspace.
(Wepin Workspace > Development Tools menu > Login tab > Auth Key > Delete)

The Auth Key menu is visible only if an authentication key was previously generated.


Supported Version
Supported from version 0.0.5 and later.
Parameters

provider <String> - The OAuth login provider (e.g., 'google', 'naver', 'discord', 'apple').
clientId <String> - The client ID of the OAuth login provider.


Note
For details on setting up OAuth providers, refer to the OAuth Login Provider Setup section.

Returns

Future<LoginResult>

provider <'external_token'> - The provider used for the login.
token <WepinFBToken>

idToken <String> - The Wepin Firebase ID token.
refreshToken <String> - The Wepin Firebase refresh token.





Exception

WepinError

Example
final user = await wepinLogin.loginFirebaseWithOauthProvider(
provider:'apple',
clietId:'apple-client-id'
);
copied to clipboard

response

LoginResult(
provider: "apple",
token: WepinFBToken(
idToken: "ab2231df....ad0f3291",
refreshToken: "eyJHGciO....adQssw5c",
)
)

copied to clipboard
loginWepinWithOauthProvider #
await wepinLogin.loginWepinWithOauthProvider({required String provider, required String clientId})
copied to clipboard
This method combines the functionality of loginFirebaseWithOauthProvider and loginWepin.
It opens an in-app browser to log in to Wepin through the specified OAuth login provider. Upon successful login, it returns Wepin user information.

Caution
This method can only be used after the authentication key has been deleted from the Wepin Workspace.
(Wepin Workspace > Development Tools menu > Login tab > Auth Key > Delete)

The Auth Key menu is visible only if an authentication key was previously generated.


Supported Version
Supported from version 0.0.5 and later.
Parameters

provider <String> - The OAuth login provider (e.g., 'google', 'naver', 'discord', 'apple').
clientId <String> - The client ID of the OAuth login provider.


Note
For details on setting up OAuth providers, refer to the OAuth Login Provider Setup section.

Returns

Future<WepinUser> - A Future that resolves to a WepinUser object containing the user's login status and information.

status <'success'|'fail'> - The login status.
userInfo <WepinUserInfo> optional - The user's information, including:

userId <String> - The user's ID.
email <String> - The user's email.
provider <'google'|'apple'|'naver'|'discord'|'email'|'external_token'> - The login provider.
use2FA <bool> - Whether the user uses two-factor authentication.


walletId <String> = The user's wallet ID.
userStatus: <WepinUserStatus> - The user's status of wepin login. including:

loginStatus: <'complete' | 'pinRequired' | 'registerRequired'> - If the user's loginStatus value is not complete, the user must be registered in Wepin.
pinRequired?:


token: <WepinToken> - The user's token of wepin.

accessToken: <String> - The access token.
refreshToken <String> - The refresh token.





Exception

WepinError

Example
final wepinLogin = WepinLogin(appId: 'appId', appKey: 'appKey');
await wepinLogin.init();
final userInfo = await wepinLogin.loginWepinWithOauthProvider(
provider: 'google',
clientId; 'google-client-id'
);

final userStatus = userInfo.userStatus;
if (userStatus.loginStatus == 'pinRequired' || userStatus.loginStatus == 'registerRequired') {
// Wepin register
}
copied to clipboard

response

WepinUser(
status: "success",
userInfo: WepinUserInfo(
userId: "120349034824234234",
email: "abc@gmail.com",
provider: "google",
use2FA: true,
),
walletId: "abcdsfsf123",
userStatus: WepinUserStatus(
loginStatus: "complete",
pinRequired: false,
),
token: WepinToken(
accessToken: "access_token",
refreshToken: "refresh_token",
)
)
copied to clipboard
loginWepinWithIdToken #
await wepinLogin.loginWepinWithIdToken({required String idToken, String? sign})
copied to clipboard
This method integrates the functions of loginWithIdToken and loginWepin.
The loginWepinWithIdToken method logs the user into Wepin using an external ID token. Upon successful login, it returns Wepin user information.
Supported Version
Supported from version 0.0.5 and later.
Parameters

idToken <String> - The id token value to be used for login.
sign <String?> - optional The signature value for the token provided as the first parameter. getSignForLogin())


Note
If you choose to remove the authentication key issued from the Wepin Workspace, you may opt not to use the sign value.
(Wepin Workspace > Development Tools menu > Login tab > Auth Key > Delete)

The Auth Key menu is visible only if an authentication key was previously generated.


Returns

Future<WepinUser> - A Future that resolves to a WepinUser object containing the user's login status and information.

status <'success'|'fail'> - The login status.
userInfo <WepinUserInfo> optional - The user's information, including:

userId <String> - The user's ID.
email <String> - The user's email.
provider <'google'|'apple'|'naver'|'discord'|'email'|'external_token'> - The login provider.
use2FA <bool> - Whether the user uses two-factor authentication.


walletId <String> = The user's wallet ID.
userStatus: <WepinUserStatus> - The user's status of wepin login. including:

loginStatus: <'complete' | 'pinRequired' | 'registerRequired'> - If the user's loginStatus value is not complete, the user must be registered in Wepin.
pinRequired?:


token: <WepinToken> - The user's token of wepin.

accessToken: <String> - The access token.
refreshToken <String> - The refresh token.





Exception

WepinError

Example
final wepinLogin = WepinLogin(appId: 'appId', appKey: 'appKey');
await wepinLogin.init();
final userInfo = await wepinLogin.loginWepinWithIdToken(
idToken:'eyJHGciO....adQssw5c',
);

final userStatus = userInfo.userStatus;
if (userStatus.loginStatus == 'pinRequired' || userStatus.loginStatus == 'registerRequired') {
// Wepin register
}
copied to clipboard

response

WepinUser(
status: "success",
userInfo: WepinUserInfo(
userId: "120349034824234234",
email: "abc@gmail.com",
provider: "external_token",
use2FA: true,
),
walletId: "abcdsfsf123",
userStatus: WepinUserStatus(
loginStatus: "complete",
pinRequired: false,
),
token: WepinToken(
accessToken: "access_token",
refreshToken: "refresh_token",
)
)
copied to clipboard
loginWepinWithAccessToken #
await wepinLogin.loginWepinWithAccessToken({required String provider, required String accessToken, String? sign})
copied to clipboard
This method integrates the functions of loginWithAccessToken and loginWepin.
The loginWepinWithAccessToken method logs the user into Wepin using an external access token. Upon successful login, it returns Wepin user information.
Supported Version
Supported from version 0.0.5 and later.
Parameters

provider <'naver'|'discord'> - The provider that issued the access token.
accessToken <String> - The access token value to be used for login.
sign <String?> - optional The signature value for the token provided as the first parameter. getSignForLogin())


Note
If you choose to remove the authentication key issued from the Wepin Workspace, you may opt not to use the sign value.
(Wepin Workspace > Development Tools menu > Login tab > Auth Key > Delete)

The Auth Key menu is visible only if an authentication key was previously generated.


Returns

Future<WepinUser> - A Future that resolves to a WepinUser object containing the user's login status and information.

status <'success'|'fail'> - The login status.
userInfo <WepinUserInfo> optional - The user's information, including:

userId <String> - The user's ID.
email <String> - The user's email.
provider <'google'|'apple'|'naver'|'discord'|'email'|'external_token'> - The login provider.
use2FA <bool> - Whether the user uses two-factor authentication.


walletId <String> = The user's wallet ID.
userStatus: <WepinUserStatus> - The user's status of wepin login. including:

loginStatus: <'complete' | 'pinRequired' | 'registerRequired'> - If the user's loginStatus value is not complete, the user must be registered in Wepin.
pinRequired?:


token: <WepinToken> - The user's token of wepin.

accessToken: <String> - The access token.
refreshToken <String> - The refresh token.





Exception

WepinError

Example
final wepinLogin = WepinLogin(appId: 'appId', appKey: 'appKey');
await wepinLogin.init();
final userInfo = await wepinLogin.loginWepinWithAccessToken(
provider: 'naver',
accessToken:'eyJHGciO....adQssw5c',
);

final userStatus = userInfo.userStatus;
if (userStatus.loginStatus == 'pinRequired' || userStatus.loginStatus == 'registerRequired') {
// Wepin register
}
copied to clipboard

response

WepinUser(
status: "success",
userInfo: WepinUserInfo(
userId: "120349034824234234",
email: "abc@naver.com",
provider: "external_token",
use2FA: true,
),
walletId: "abcdsfsf123",
userStatus: WepinUserStatus(
loginStatus: "complete",
pinRequired: false,
),
token: WepinToken(
accessToken: "access_token",
refreshToken: "refresh_token",
)
)
copied to clipboard
loginWepinWithEmailAndPassword #
await wepinLogin.loginWepinWithEmailAndPassword({required String email, required String password})
copied to clipboard
This method integrates the functions of loginWithEmailAndPassword and loginWepin.
The loginWepinWithEmailAndPassword method logs the user into Wepin using the provided email and password. Upon successful login, it returns Wepin user information.
Supported Version
Supported from version 0.0.5 and later.
Parameters

email <String> - The user's email address.
password <String> - The user's password.

Returns

Future<WepinUser> - A Future that resolves to a WepinUser object containing the user's login status and information.

status <'success'|'fail'> - The login status.
userInfo <WepinUserInfo> optional - The user's information, including:

userId <String> - The user's ID.
email <String> - The user's email.
provider <'google'|'apple'|'naver'|'discord'|'email'|'external_token'> - The login provider.
use2FA <bool> - Whether the user uses two-factor authentication.


walletId <String> = The user's wallet ID.
userStatus: <WepinUserStatus> - The user's status of wepin login. including:

loginStatus: <'complete' | 'pinRequired' | 'registerRequired'> - If the user's loginStatus value is not complete, the user must be registered in Wepin.
pinRequired?:


token: <WepinToken> - The user's token of wepin.

accessToken: <String> - The access token.
refreshToken <String> - The refresh token.





Exception

WepinError

Example
final wepinLogin = WepinLogin(appId: 'appId', appKey: 'appKey');
await wepinLogin.init();
final userInfo = await wepinLogin.loginWithEmailAndPassword(
email: "abc@abc.com",
password: "user_password"
);

final userStatus = userInfo.userStatus;
if (userStatus.loginStatus == 'pinRequired' || userStatus.loginStatus == 'registerRequired') {
// Wepin register
}
copied to clipboard

response

WepinUser(
status: "success",
userInfo: WepinUserInfo(
userId: "120349034824234234",
email: "abc@abc.com",
provider: "email",
use2FA: true,
),
walletId: "abcdsfsf123",
userStatus: WepinUserStatus(
loginStatus: "complete",
pinRequired: false,
),
token: WepinToken(
accessToken: "access_token",
refreshToken: "refresh_token",
)
)
copied to clipboard
logout #
await wepinLogin.logout()
copied to clipboard
The logout() method logs out the currently logged-in user from Wepin.
Parameters

None

Returns

Future<bool> - A Future that resolves to true if the logout was successful.

Exception

WepinError

Example
final result = await wepinLogin.logout();
if (result) {
// Successfully logged out
}
copied to clipboard
finalize #
await wepinLogin.finalize()
copied to clipboard
The finalize() method finalizes and cleans up the Wepin Login Library, releasing any resources that were used.
Parameters

None

Returns

Future/

Example
await wepinLogin.finalize();
copied to clipboard
WepinError #
This section provides descriptions of various error codes that may be encountered while using the Wepin Login Library functionalities. Each error code corresponds to a specific issue, and understanding these can help in debugging and handling errors effectively.



Error Code
Error Message
Error Description




invalidAppKey
"InvalidAppKey"
The Wepin app key is invalid.


invalidParameters `
"InvalidParameters"
One or more parameters provided are invalid or missing.


invalidLoginProvider
"InvalidLoginProvider"
The login provider specified is not supported or is invalid.


invalidToken
"InvalidToken"
The token does not exist.


invalidLoginSession
"InvalidLoginSession"
The login session information does not exist.


notInitialized
"NotInitialized"
The WepinLoginLibrary has not been properly initialized.


alreadyInitialized
"AlreadyInitialized"
The WepinLoginLibrary is already initialized, so the logout operation cannot be performed again.


userCancelled
"UserCancelled"
The user has cancelled the operation.


unknownError
"UnknownError"
An unknown error has occurred, and the cause is not identified.


notConnectedInternet
"NotConnectedInternet"
The system is unable to detect an active internet connection.


failedLogin
"FailedLogin"
The login attempt has failed due to incorrect credentials or other issues.


alreadyLogout
"AlreadyLogout"
The user is already logged out, so the logout operation cannot be performed again.


invalidEmailDomain
"InvalidEmailDomain"
The provided email address's domain is not allowed or recognized by the system.


failedSendEmail
"FailedSendEmail"
The system encountered an error while sending an email. This is because the email address is invalid or we sent verification emails too often. Please change your email or try again after 1 minute.


requiredEmailVerified
"RequiredEmailVerified"
Email verification is required to proceed with the requested operation.


incorrectEmailForm
"incorrectEmailForm"
The provided email address does not match the expected format.


incorrectPasswordForm
"IncorrectPasswordForm"
The provided password does not meet the required format or criteria.


notInitializedNetwork
"NotInitializedNetwork"
The network or connection required for the operation has not been properly initialized.


requiredSignupEmail
"RequiredSignupEmail"
The user needs to sign up with an email address to proceed.


failedEmailVerified
"FailedEmailVerified"
The WepinLoginLibrary encountered an issue while attempting to verify the provided email address.


failedPasswordStateSetting
"FailedPasswordStateSetting"
Failed to set the password state. This error may occur during password management operations, potentially due to invalid input or system issues.


failedPasswordSetting
"failedPasswordSetting"
Failed to set the password. This could be due to issues with the provided password or internal errors during the password setting process.


existedEmail
"ExistedEmail"
The provided email address is already registered. This error occurs when attempting to sign up with an email that is already in use.


apiRequestError
"ApiRequestError"
There was an error while making the API request. This can happen due to network issues, invalid endpoints, or server errors.


incorrectLifecycleException
"IncorrectLifecycleException"
The lifecycle of the Wepin SDK is incorrect for the requested operation. Ensure that the SDK is in the correct state (e.g., initialized and login) before proceeding.


failedRegister
"FailedRegister"
Failed to register the user. This can occur due to issues with the provided registration details or internal errors during the registration process.


accountNotFound
"AccountNotFound"
The specified account was not found. This error is returned when attempting to access an account that does not exist in the Wepin.


nftNotFound
"NftNotFound"
The specified NFT was not found. This error occurs when the requested NFT does not exist or is not accessible within the user's account.


failedSend
"FailedSend"
Failed to send the required data or request. This error could be due to network issues, incorrect data, or internal server errors.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter