Methods
These are the methods provided by the Wepin iOS Login Library.
Methods can be used after initialization of Wepin Login Library.
loginWithOauthProvider
An in-app browser will open and proceed to log in to the OAuth provider. To retrieve Firebase login information, you need to execute either the loginWithIdToken() or loginWithAccessToken() method.
Parameters
params
<WepinLoginOauth2Params>provider
<'google'|'naver'|'discord'|'apple'> - Provider for loginclientId
<String>
viewController
<UIViewController>
Returns
<WepinLoginOauthResult>
provider
<String> - login providertoken
<String> - accessToken (if provider is "naver" or "discord") or idToken (if provider is "google" or "apple")type
<WepinOauthTokenType> - type of token
Exception
Example
signUpWithEmailAndPassword
This function signs up on Wepin Firebase with your email and password. It returns Firebase login information upon successful signup.
Parameters
params
<WepinLoginWithEmailParams>email
<String> - User emailpassword
<String> - User passwordlocale
<String> - optional Language for the verification email (default value: "en")
Returns
<WepinLoginResult>
provider
<WepinLoginProviders>token
<WepinFBToken>idToken
<String> - wepin firebase idTokenrefreshToken
- wepin firebase refreshToken
Exception
Example
loginWithEmailAndPassword
This function logs in to the Wepin Firebase using your email and password. It returns Firebase login information upon successful login.
Parameters
params
<WepinLoginWithEmailParams>email
<String> - User emailpassword
<String> - User password
Returns
<WepinLoginResult>
provider
<WepinLoginProviders>token
<WepinFBToken>idToken
<String> - wepin firebase idTokenrefreshToken
` - wepin firebase refreshToken
Exception
Example
loginWithIdToken
This function logs in to the Wepin Firebase using an external ID token. It returns Firebase login information upon successful login.
Parameters
params
<WepinLoginOauthIdTokenRequest>idToken
<String> - ID token value to be used for loginsign
<String> - Signature value for the token provided as the first parameter.(Returned value of getSignForLogin())
Returns
<WepinLoginResult>
provider
<WepinLoginProviders>token
<WepinFBToken>idToken
<String> - wepin firebase idTokenrefreshToken
` - wepin firebase refreshToken
Exception
Example
loginWithAccessToken
This function logs in to the Wepin Firebase using an external access token. It returns Firebase login information upon successful login.
Parameters
params
<WepinLoginOauthAccessTokenRequest>provider
<"naver"|"discord"> - Provider that issued the access tokenaccessToken
<String> - Access token value to be used for loginsign
<String> - Signature value for the token provided as the first parameter. (Returned value of getSignForLogin())
Returns
<WepinLoginResult>
provider
<WepinLoginProviders>token
<WepinFBToken>idToken
<String> - wepin firebase idTokenrefreshToken
` - wepin firebase refreshToken
Exception
Example
getRefreshFirebaseToken
This method retrieves the current firebase token's information from the Wepin.
Parameters
void
Returns
<WepinLoginResult>
provider
<WepinLoginProviders>token
<WepinFBToken>idToken
<String> - wepin firebase idTokenrefreshToken
` - wepin firebase refreshToken
Exception
Example
loginWepin
This method logs the user into the Wepin application using the specified provider and token.
Parameters
The parameters should utilize the return values from the loginWithEmailAndPassword()
, loginWithIdToken()
, and loginWithAccessToken()
methods within this module.
<WepinLoginResult>
provider
<WepinLoginProviders>token
<WepinFBToken>idToken
<String> - Wepin Firebase idTokenrefreshToken
` - Wepin Firebase refreshToken
Returns
<WepinUser> - An object containing the user's login status and information. The object includes:
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 <WepinLoginProviders> - 'google'|'apple'|'naver'|'discord'|'email'|'external_token'
use2FA <Bool> - Whether the user uses two-factor authentication.
walletId <String> optional - The user's wallet ID.
userStatus: <WepinUserStatus> optional - The user's status of wepin login. including:
loginStatus: <WepinLoginStatus> - 'complete' | 'pinRequired' | 'registerRequired' - If the user's loginStatus value is not complete, it must be registered in the wepin.
pinRequired: optional
token: <WepinToken> optional - The user's token of wepin.
refresh: <String>
access <String>
Exception
Example
getCurrentWepinUser
This method retrieves the current logged-in user's information from the Wepin.
Parameters
void
Returns
<WepinUser> - An object containing the user's login status and information. The object includes:
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 <WepinLoginProviders> - 'google'|'apple'|'naver'|'discord'|'email'|'external_token'
use2FA <Bool> - Whether the user uses two-factor authentication.
walletId <String> optional - The user's wallet ID.
userStatus: <WepinUserStatus> optional - The user's status of wepin login. including:
loginStatus: <WepinLoginStatus> - 'complete' | 'pinRequired' | 'registerRequired' - If the user's loginStatus value is not complete, it must be registered in the wepin.
pinRequired: optional
token: <WepinToken> optional - The user's token of wepin.
refresh: <String>
access <String>
Exception
Example
logoutWepin
This method logs out the user logged into Wepin.
Parameters
void
Returns
<Bool>
Exception
Example
getSignForLogin
Generates signatures to verify the issuer. It is mainly used to generate signatures for login-related information such as ID tokens and access tokens.
Parameters
privKey
<String> - The authentication key used for signature generation.message
<String> - The message or payload to be signed.
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.
Returns
String - The generated signature.
The authentication key (privKey
) 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.
Example
finalize
This method finalizes the Wepin Login Library.
Parameters
void
Returns
void
Example
WepinLoginError
Last updated