@desmoslabs/desmjs-web3auth-mobile
Enumerations
Classes
Interfaces
Type Aliases
BUILD_ENV_TYPE
Ƭ BUILD_ENV_TYPE: typeof BUILD_ENV[keyof typeof BUILD_ENV]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:37
CUSTOM_LOGIN_PROVIDER_TYPE
Ƭ CUSTOM_LOGIN_PROVIDER_TYPE: string & { toString?: (radix?: number) => string }
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:31
LANGUAGE_TYPE
Ƭ LANGUAGE_TYPE: typeof LANGUAGES[keyof typeof LANGUAGES]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:220
LOGIN_PROVIDER_TYPE
Ƭ LOGIN_PROVIDER_TYPE: typeof LOGIN_PROVIDER[keyof typeof LOGIN_PROVIDER]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:29
LoginParams
Ƭ LoginParams: BaseRedirectParams & { curve?: SUPPORTED_KEY_CURVES_TYPE ; dappShare?: string ; extraLoginOptions?: ExtraLoginOptions ; getWalletKey?: boolean ; loginProvider: LOGIN_PROVIDER_TYPE | CUSTOM_LOGIN_PROVIDER_TYPE ; mfaLevel?: MfaLevelType }
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:134
MFA_FACTOR_TYPE
Ƭ MFA_FACTOR_TYPE: typeof MFA_FACTOR[keyof typeof MFA_FACTOR]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:454
MFA_SETTINGS
Ƭ MFA_SETTINGS: Object
Type declaration
| Name | Type |
|---|---|
enable | boolean |
mandatory? | boolean |
priority? | number |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:455
MfaLevelType
Ƭ MfaLevelType: typeof MFA_LEVELS[keyof typeof MFA_LEVELS]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:34
MfaSettings
Ƭ MfaSettings: Partial<Record<MFA_FACTOR_TYPE, MFA_SETTINGS>>
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:460
OPENLOGIN_NETWORK_TYPE
Ƭ OPENLOGIN_NETWORK_TYPE: typeof OPENLOGIN_NETWORK[keyof typeof OPENLOGIN_NETWORK]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:36
OpenloginUserInfo
Ƭ OpenloginUserInfo: Object
Type declaration
| Name | Type | Description |
|---|---|---|
aggregateVerifier? | string | - |
appState? | string | - |
dappShare? | string | - |
email? | string | - |
idToken? | string | Token issued by Web3Auth. |
isMfaEnabled? | boolean | - |
name? | string | - |
oAuthAccessToken? | string | Access Token issued by OAuth provider. Will be available only if you are using custom verifiers. |
oAuthIdToken? | string | Token issued by OAuth provider. Will be available only if you are using custom verifiers. |
profileImage? | string | - |
touchIDPreference? | string | - |
typeOfLogin | LOGIN_PROVIDER_TYPE | CUSTOM_LOGIN_PROVIDER_TYPE | - |
verifier | string | - |
verifierId | string | - |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:399
RedirectEvent
Ƭ RedirectEvent: Object
Type declaration
| Name | Type |
|---|---|
url | string |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:1
SUPPORTED_KEY_CURVES_TYPE
Ƭ SUPPORTED_KEY_CURVES_TYPE: typeof SUPPORTED_KEY_CURVES[keyof typeof SUPPORTED_KEY_CURVES]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:35
SdkInitParams
Ƭ SdkInitParams: Omit<OpenLoginOptions & SdkSpecificInitParams, "no3PC" | "uxMode" | "replaceUrlOnRedirect" | "originData">
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/interface.d.ts:6
SdkLoginParams
Ƭ SdkLoginParams: Omit<LoginParams, "fastLogin" | "skipTKey" | "getWalletKey"> & Required<Pick<LoginParams, "loginProvider">>
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/interface.d.ts:7
ServiceActionResult
Ƭ ServiceActionResult: Object
Type declaration
| Name | Type |
|---|---|
servicePackage? | string |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:130
SocialMfaModParams
Ƭ SocialMfaModParams: Object
Type declaration
| Name | Type | Description |
|---|---|---|
extraLoginOptions? | ExtraLoginOptions | extraLoginOptions can be used to pass standard oauth login options to loginProvider. For ex: you will have to pass login_hint as user's email and domain as your app domain in extraLoginOptions while using email_passwordless loginProvider |
loginProvider | LOGIN_PROVIDER_TYPE | CUSTOM_LOGIN_PROVIDER_TYPE | loginProvider sets the oauth login method to be used. You can use any of the valid loginProvider from the supported list. |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:193
State
Ƭ State: OpenloginSessionData
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/interface.d.ts:9
THEME_MODE_TYPE
Ƭ THEME_MODE_TYPE: typeof THEME_MODES[keyof typeof THEME_MODES]
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:226
TypeOfLogin
Ƭ TypeOfLogin: "google" | "facebook" | "reddit" | "discord" | "twitch" | "apple" | "github" | "linkedin" | "twitter" | "weibo" | "line" | "email_password" | "passwordless" | "jwt" | "webauthn"
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:305
WebBrowserAuthSessionResult
Ƭ WebBrowserAuthSessionResult: WebBrowserRedirectResult | WebBrowserResult
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:75
WebBrowserCompleteAuthSessionOptions
Ƭ WebBrowserCompleteAuthSessionOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
skipRedirectCheck? | boolean | Attempt to close the window without checking to see if the auth redirect matches the cached redirect URL. |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:136
WebBrowserCompleteAuthSessionResult
Ƭ WebBrowserCompleteAuthSessionResult: Object
Type declaration
| Name | Type | Description |
|---|---|---|
message | string | Additional description or reasoning of the result. |
type | "success" | "failed" | Type of the result. |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:142
WebBrowserCoolDownResult
Ƭ WebBrowserCoolDownResult: ServiceActionResult
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:135
WebBrowserCustomTabsResults
Ƭ WebBrowserCustomTabsResults: Object
Type declaration
| Name | Type | Description |
|---|---|---|
browserPackages | string[] | All packages recognized by PackageManager as capable of handling Custom Tabs. Empty array means there is no supporting browsers on device. |
defaultBrowserPackage? | string | Default package chosen by user, null if there is no such packages. Also null usually means, that user will be prompted to choose from available packages. |
preferredBrowserPackage? | string | Package preferred by CustomTabsClient to be used to handle Custom Tabs. It favors browser chosen by user as default, as long as it is present on both browserPackages and servicePackages lists. Only such browsers are considered as fully supporting Custom Tabs. It might be null when there is no such browser installed or when default browser is not in servicePackages list. |
servicePackages | string[] | All packages recognized by PackageManager as capable of handling Custom Tabs Service. This service is used by warmUpAsync, mayInitWithUrlAsync and coolDownAsync. |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:76
WebBrowserMayInitWithUrlResult
Ƭ WebBrowserMayInitWithUrlResult: ServiceActionResult
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:133
WebBrowserOpenOptions
Ƭ WebBrowserOpenOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
browserPackage? | string | Package name of a browser to be used to handle Custom Tabs. List of available packages is to be queried by getCustomTabsSupportingBrowsers method. Platform android |
controlsColor? | string | Tint color for controls in SKSafariViewController in #AARRGGBB or #RRGGBB format. Platform ios |
createTask? | boolean | A boolean determining whether the browser should open in a new task or in the same task as your app. Default ts true Platform android |
dismissButtonStyle? | "done" | "close" | "cancel" | The style of the dismiss button. Should be one of: done, close, or cancel. Platform ios |
enableBarCollapsing? | boolean | A boolean determining whether the toolbar should be hiding when a user scrolls the website. |
enableDefaultShareMenuItem? | boolean | A boolean determining whether a default share item should be added to the menu. Platform android |
readerMode? | boolean | A boolean determining whether Safari should enter Reader mode, if it is available. Platform ios |
secondaryToolbarColor? | string | Color of the secondary toolbar in either #AARRGGBB or #RRGGBB format. Platform android |
showInRecents? | boolean | A boolean determining whether browsed website should be shown as separate entry in Android recents/multitasking view. Requires createTask to be true (default). Default ts false Platform android |
showTitle? | boolean | A boolean determining whether the browser should show the title of website on the toolbar. Platform android |
toolbarColor? | string | Color of the toolbar in either #AARRGGBB or #RRGGBB format. |
windowFeatures? | string | WebBrowserWindowFeatures | Features to use with window.open(). Platform web |
windowName? | string | Name to assign to the popup window. Platform web |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:5
WebBrowserRedirectResult
Ƭ WebBrowserRedirectResult: Object
Type declaration
| Name | Type | Description |
|---|---|---|
type | "success" | Type of the result. |
url | string | - |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:123
WebBrowserResult
Ƭ WebBrowserResult: Object
Type declaration
| Name | Type | Description |
|---|---|---|
type | WebBrowserResultType | Type of the result. |
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:117
WebBrowserWarmUpResult
Ƭ WebBrowserWarmUpResult: ServiceActionResult
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:134
WebBrowserWindowFeatures
Ƭ WebBrowserWindowFeatures: Record<string, number | boolean | string>
Defined in
node_modules/@web3auth/react-native-sdk/dist/types/types/IWebBrowser.d.ts:4
WhiteLabelData
Ƭ WhiteLabelData: Object
Type declaration
| Name | Type | Description |
|---|---|---|
appName? | string | App name to display in the UI |
appUrl? | string | App url |
defaultLanguage? | LANGUAGE_TYPE | language which will be used by web3auth. app will use browser language if not specified. if language is not supported it will use "en" en: english de: german ja: japanese ko: korean zh: mandarin es: spanish fr: french pt: portuguese nl: dutch Default Value ts en |
logoDark? | string | App logo to use in dark mode |
logoLight? | string | App logo to use in light mode |
mode? | THEME_MODE_TYPE | theme * * Default Value ts auto |
privacyPolicy? | Partial<Record<LANGUAGE_TYPE, string>> | Language specific link for privacy policy on torus-website. See (examples/vue-app) to configure e.g. privacyPolicy: { en: "http://example.com/tnc/en", ja: "http://example.com/tnc/ja", } |
theme? | { error?: string ; gray?: string ; green?: string ; info?: string ; primary?: string ; red?: string ; success?: string ; warning?: string ; white?: string } | Used to customize theme of the login modal with following options 'primary' - To customize primary color of modal's content. |
theme.error? | string | - |
theme.gray? | string | - |
theme.green? | string | - |
theme.info? | string | - |
theme.primary? | string | - |
theme.red? | string | - |
theme.success? | string | - |
theme.warning? | string | - |
theme.white? | string | - |
tncLink? | Partial<Record<LANGUAGE_TYPE, string>> | Language specific link for terms and conditions on torus-website. See (examples/vue-app) to configure e.g. tncLink: { en: "http://example.com/tnc/en", ja: "http://example.com/tnc/ja", } |
useLogoLoader? | boolean | Use logo loader Default Value ts false |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:227
Variables
BUILD_ENV
• Const BUILD_ENV: Object
Type declaration
| Name | Type |
|---|---|
DEVELOPMENT | "development" |
PRODUCTION | "production" |
STAGING | "staging" |
TESTING | "testing" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/constants.d.ts:50
LANGUAGES
• Const LANGUAGES: Object
Type declaration
| Name | Type |
|---|---|
de | "de" |
en | "en" |
es | "es" |
fr | "fr" |
ja | "ja" |
ko | "ko" |
nl | "nl" |
pt | "pt" |
zh | "zh" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:209
LOGIN_PROVIDER
• Const LOGIN_PROVIDER: Object
Type declaration
| Name | Type |
|---|---|
APPLE | "apple" |
DISCORD | "discord" |
EMAIL_PASSWORDLESS | "email_passwordless" |
FACEBOOK | "facebook" |
GITHUB | "github" |
GOOGLE | "google" |
JWT | "jwt" |
KAKAO | "kakao" |
LINE | "line" |
LINKEDIN | "linkedin" |
REDDIT | "reddit" |
SMS_PASSWORDLESS | "sms_passwordless" |
TWITCH | "twitch" |
TWITTER | "twitter" |
WEBAUTHN | "webauthn" |
WECHAT | "wechat" |
WEIBO | "weibo" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/constants.d.ts:20
MFA_FACTOR
• Const MFA_FACTOR: Object
Type declaration
| Name | Type |
|---|---|
BACKUP_SHARE | "backUpShareFactor" |
DEVICE | "deviceShareFactor" |
PASSWORD | "passwordFactor" |
SOCIAL_BACKUP | "socialBackupFactor" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:448
MFA_LEVELS
• Const MFA_LEVELS: Object
Type declaration
| Name | Type |
|---|---|
DEFAULT | "default" |
MANDATORY | "mandatory" |
NONE | "none" |
OPTIONAL | "optional" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/constants.d.ts:39
OPENLOGIN_NETWORK
• Const OPENLOGIN_NETWORK: Object
Type declaration
| Name | Type |
|---|---|
AQUA | "aqua" |
CELESTE | "celeste" |
CYAN | "cyan" |
MAINNET | "mainnet" |
SAPPHIRE_DEVNET | "sapphire_devnet" |
SAPPHIRE_MAINNET | "sapphire_mainnet" |
TESTNET | "testnet" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/constants.d.ts:7
SUPPORTED_KEY_CURVES
• Const SUPPORTED_KEY_CURVES: Object
Type declaration
| Name | Type |
|---|---|
ED25519 | "ed25519" |
SECP256K1 | "secp256k1" |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/constants.d.ts:16
THEME_MODES
• Const THEME_MODES: Object
Type declaration
| Name | Type |
|---|---|
auto | string |
dark | string |
light | string |
Defined in
node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:221