Skip to content

Commit

Permalink
not fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
shahbaz17 committed Nov 15, 2023
1 parent eb621b2 commit 2a7d4df
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 36 deletions.
32 changes: 16 additions & 16 deletions docs/sdk/pnp/android/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ Then, you should specify the details of your verifier in the `LoginConfigItem` s

| Parameter | Type | Mandatory | Description |
| --------------------- | ------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| verifier | String | Yes | The name of the verifier which you have registered on the Web3Auth Dashboard. |
| verifier | String | Yes | The name of the verifier that you have registered on the Web3Auth Dashboard. |
| typeOfLogin | Enum`<TypeOfLogin>` | Yes | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose google, a google sign-in flow will be used. If you choose jwt, which you should be providing your own JWT token, no sign-in flow will be presented. |
| name | String? | No | Name of your verifier for display purpose. |
| clientId | String | Yes | The Client Id of the login provider. e.g. Google's Client ID |
| name | String? | No | Name of your verifier. |
| description | String? | No | Description of this login flow. |
| clientId | String? | No | The Client Id of the login provider. e.g. Google's Client ID |
| verifierSubIdentifier | String? | No | The name of the field in the JWT that should be used as the unique user ID of the JWT. Should be same as the one you used |
| logoHover | String? | No | Logo to be shown on mouse hover. |
| logoLight | String? | No | Light logo for dark background |
Expand All @@ -70,19 +70,19 @@ Then, you should specify the details of your verifier in the `LoginConfigItem` s

```kotlin
data class LoginConfigItem(
var verifier: String,
private var typeOfLogin: TypeOfLogin,
private var name: String? = null,
private var description: String? = null,
private var clientId: String? = null,
private var verifierSubIdentifier: String? = null,
private var logoHover: String? = null,
private var logoLight: String? = null,
private var logoDark: String? = null,
private var mainOption: Boolean? = false,
private var showOnModal: Boolean? = true,
private var showOnDesktop: Boolean? = true,
private var showOnMobile: Boolean? = true,
var verifier: String,
private var typeOfLogin: TypeOfLogin,
private var name: String? = null,
private var description: String? = null,
private var clientId: String,
private var verifierSubIdentifier: String? = null,
private var logoHover: String? = null,
private var logoLight: String? = null,
private var logoDark: String? = null,
private var mainOption: Boolean? = false,
private var showOnModal: Boolean? = true,
private var showOnDesktop: Boolean? = true,
private var showOnMobile: Boolean? = true,
)
```

Expand Down
8 changes: 3 additions & 5 deletions docs/sdk/pnp/android/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,11 @@ FACEBOOK, TWITTER, EMAIL_PASSWORDLESS, etc. `web3Auth.login()` requires `LoginPa
| Parameter | Type | Mandatory | Description |
| ------------------- | -------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `loginProvider` | `enum` `com.web3auth.core.Web3Auth.Provider` | Yes | Login provider, supported values are `GOOGLE`, `FACEBOOK`, `REDDIT`, `DISCORD`, `TWITCH`, `APPLE`, `LINE`, `GITHUB`, `KAKAO`, `LINKEDIN`, `TWITTER`, `WEIBO`, `WECHAT`, `EMAIL_PASSWORDLESS`, `JWT` |
| `dappShare` | `String` | No | Dapp share can be used to pass dapp share url, default is `null` |
| `extraLoginOptions` | `Map<String, Any>` | No | You can pass various oauth supported options, default is `null` |
| `sessionTime` | `Int` | No | Session time to be passed to set the session of a user that will be returned to sessionResponse() |
| `redirectUrl` | `android.net.Uri` | No | Url where user will be redirected after successfull login. By default user will be redirected to same page where login will be initiated, default is `null` |
| `appState` | `String` | No | appState can be used to keep track of the app state when user will be redirected to app after login, default is `null` |
| `mfaLevel` | `Map<String, Any>` | No | MFA level can be used to pass 2FA screen shown during login, default is `mfaLevel.DEFAULT`, shown every 3rd login. |
| `dappShare` | `String` | No | Dapp share can be used to pass dapp share url, default is `null` |
| `curve` | `Map<String, Any>` | No | Curve can be used to pass curve options, `ED25519` for Solana and `SECP256K1` for Ethereum |

</TabItem>
Expand All @@ -52,11 +51,10 @@ data class LoginParams(
val loginProvider: Provider,
var dappShare: String? = null,
val extraLoginOptions: ExtraLoginOptions? = null,
val redirectUrl: Uri? = null,
@Transient var redirectUrl: Uri? = null,
val appState: String? = null,
val mfaLevel: MFALevel? = null,
val sessionTime: Int? = null,
val curve: Curve? = null
val curve: Curve? = Curve.SECP256K1
)
```

Expand Down
12 changes: 6 additions & 6 deletions docs/sdk/pnp/flutter/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ Then, specify the details of your verifier in the `LoginConfigItem` struct as fo

| Parameter | Type | Mandatory | Description |
| --------------------- | ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| verifier | String | Yes | The name of the verifier which you have registered on the Web3Auth Dashboard. |
| verifier | String | Yes | The name of the verifier that you have registered on the Web3Auth Dashboard. |
| typeOfLogin | `TypeOfLogin` | Yes | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose `google`, a Google sign-in flow will be used. If you choose `jwt`, you should be providing your own JWT token, no sign-in flow will be presented. |
| name | String? | No | Name of your verifier for display purpose. |
| clientId | String? | No | The Client Id of the login provider. e.g. Google's Client ID or Web3Auth's client Id if using 'jwt' as TypeOfLogin. |
| clientId | String | Yes | The Client Id of the login provider. e.g. Google's Client ID or Web3Auth's client Id if using 'jwt' as TypeOfLogin. |
| name | String? | No | Name of your verifier. |
| description | String? | No | Description of this login flow. |
| verifierSubIdentifier | String? | No | The name of the field in the JWT that should be used as the unique user ID of the JWT. Should be same as the one you used. |
| logoHover | String? | No | Logo to be shown on mouse hover. |
Expand All @@ -72,9 +72,9 @@ Then, specify the details of your verifier in the `LoginConfigItem` struct as fo
class LoginConfigItem {
final String verifier;
final TypeOfLogin typeOfLogin;
final String clientId;
final String? name;
final String? description;
final String? clientId;
final String? verifierSubIdentifier;
final String? logoHover;
final String? logoLight;
Expand All @@ -87,9 +87,9 @@ class LoginConfigItem {
LoginConfigItem(
{required this.verifier,
required this.typeOfLogin,
required this.clientId,
this.name,
this.description,
this.clientId,
this.verifierSubIdentifier,
this.logoHover,
this.logoLight,
Expand All @@ -103,9 +103,9 @@ class LoginConfigItem {
return {
'verifier': verifier,
'typeOfLogin': typeOfLogin.name,
'clientId': clientId,
'name': name,
'description': description,
'clientId': clientId,
'verifierSubIdentifier': verifierSubIdentifier,
'logoHover': logoHover,
'logoLight': logoLight,
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/flutter/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,14 @@ Make sure your sign-in activity launchMode is set to **singleTop** in your `Andr
https://github.com/Web3Auth/web3auth-swift-sdk
```

From the `Dependency Rule` dropdown, select `Exact Version` and enter `7.4.0` as the version.
From the `Dependency Rule` dropdown, select `Exact Version` and enter `7.4.1` as the version.

1. When finished, Xcode will automatically begin resolving and downloading your dependencies in the background.

### Cocoapods

```sh
pod 'Web3Auth', '~> 7.4.0'
pod 'Web3Auth', '~> 7.4.1'
```

### Configuration
Expand Down
8 changes: 4 additions & 4 deletions docs/sdk/pnp/ios/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ Then, you should specify the details of your verifier in the `W3ALoginConfig` st

| Parameter | Type | Mandatory | Description |
| --------------------- | ------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| verifier | String | Yes | The name of the verifier which you have registered in Web3Auth Dashboard. |
| verifier | String | Yes | The name of the verifier that you have registered in Web3Auth Dashboard. |
| typeOfLogin | Enum`<TypeOfLogin>` | Yes | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose google, a google sign-in flow will be used. If you choose jwt, which you should be providing your own JWT token, no sign-in flow will be presented. |
| name | String? | No | Name of your verifier for display purpose. |
| clientId | String | Yes | The Web3Auth ClientId you want to use for this login provider. |
| name | String? | No | Name of your verifier. |
| description | String? | No | Description of this login flow. |
| clientId | String? | No | The Web3Auth ClientId you want to use for this login provider. |
| verifierSubIdentifier | String? | No | The name of the field in the JWT that should be used as the unique user ID of the JWT. Should be same as the one you used in the verifier config. |
| logoHover | String? | No | Logo to be shown on mouse hover. |
| logoLight | String? | No | Logo to be shown on light background (light theme). |
Expand All @@ -72,9 +72,9 @@ Then, you should specify the details of your verifier in the `W3ALoginConfig` st
public struct W3ALoginConfig: Codable {
let verifier: String
let typeOfLogin: TypeOfLogin
let clientId: String
let name: String?
let description: String?
let clientId: String?
let verifierSubIdentifier: String?
let logoHover: String?
let logoLight: String?
Expand Down
Loading

1 comment on commit 2a7d4df

@vercel
Copy link

@vercel vercel bot commented on 2a7d4df Nov 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

web3auth-docs – ./

web3auth-docs-git-master-web3auth.vercel.app
web3auth-docs-web3auth.vercel.app
w3a-docs.vercel.app

Please sign in to comment.