22title : " MfaSmsList"
33---
44
5- MfaSmsList
6- Class for handling the mfa-sms-list screen.
5+ The MfaSmsList class implements the `mfa-sms-list screen functionality.
6+
7+ <Frame ><img style = { {maxHeight:" 400px" }} src = " /docs/images/ja-jp/cdy7uua7fh8z/5WKzkwCtJn5ZViHcl9xATn/6147dac2ff98da4ab190922ced35a1f2/Screenshot_2025-02-21_at_12.29.36.png" alt = " MfaSmsList" /></Frame >
8+
9+
10+ ## Constructors
11+ Create an instance of MfaSmsList screen
12+
713
814``` ts Example
915import MfaSmsList from ' @auth0/auth0-acul-js/mfa-sms-list' ;
@@ -15,36 +21,49 @@ const selectPhoneNumber = async () => {
1521}
1622```
1723
18- ## Constructors
19-
20- <ParamField body = " MfaSmsList" type = " Constructor" />
2124## Properties
2225
23- <ParamField body = ' branding' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers" >BrandingMembers</a ></span >} / >
24-
25- <ParamField body = ' client ' type = { < span >< a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers " >ClientMembers</ a ></ span > } / >
26+ <ParamField body = ' branding' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers" >BrandingMembers</a ></span >} >
27+ Provides branding-related configurations, such as branding theme and settings.
28+ </ ParamField >
2629
27- <ParamField body = ' organization' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers" >OrganizationMembers</a ></span >} />
30+ <ParamField body = ' client' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers" >ClientMembers</a ></span >} >
31+ Provides client-related configurations, such as ` id ` , ` name ` , and ` logoUrl ` .
32+ </ParamField >
2833
29- <ParamField body = ' prompt' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers" >PromptMembers</a ></span >} />
34+ <ParamField body = ' organization' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers" >OrganizationMembers</a ></span >} >
35+ Provides information about the user's organization, such as organization ` id ` and ` name ` .
36+ </ParamField >
3037
31- <ParamField body = ' screen' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembers" >ScreenMembers</a ></span >} />
38+ <ParamField body = ' prompt' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers" >PromptMembers</a ></span >} >
39+ Contains data about the current prompt in the authentication flow.
40+ </ParamField >
3241
33- <ParamField body = ' tenant' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers" >TenantMembers</a ></span >} />
42+ <ParamField body = ' screen' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembers" >ScreenMembers</a ></span >} >
43+ Contains details specific to the screen, including its configuration and context.
44+ </ParamField >
3445
35- <ParamField body = ' transaction' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers" >TransactionMembers</a ></span >} />
46+ <ParamField body = ' tenant' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers" >TenantMembers</a ></span >} >
47+ Contains data related to the tenant, such as ` id ` and associated metadata.
48+ </ParamField >
3649
37- <ParamField body = ' untrustedData' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers" >UntrustedDataMembers</a ></span >} />
50+ <ParamField body = ' transaction' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers" >TransactionMembers</a ></span >} >
51+ Provides transaction-specific data, such as active identifiers and flow states.
52+ </ParamField >
3853
39- <ParamField body = ' user' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers" >UserMembers</a ></span >} />
54+ <ParamField body = ' untrustedData' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers" >UntrustedDataMembers</a ></span >} >
55+ Handles untrusted data passed to the SDK, such as user input during login.
56+ </ParamField >
4057
41- <ParamField body = ' screenIdentifier' type = ' string' />
58+ <ParamField body = ' user' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers" >UserMembers</a ></span >} >
59+ Details of the active user, including ` username ` , ` email ` , and ` roles ` .
60+ </ParamField >
4261
4362## Methods
4463
45- <ParamField body = ' backAction' type = ' Promise<void> ' >
64+ <ParamField body = ' backAction' type = ' (options ?) ' >
4665
47- Navigates back to the previous screen.
66+ This method navigates back to the previous screen.
4867
4968``` typescript Example
5069import MfaSmsList from ' @auth0/auth0-acul-js/mfa-sms-list' ;
@@ -58,31 +77,27 @@ const handleBackAction = async () => {
5877};
5978```
6079
61- <Expandable title = " Parameters" >
62- <ParamField body = ' payload?' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions" >CustomOptions</a ></span >} >
63-
64- Optional payload for the action.
80+ <ParamField body = " options" type = " OPTIONAL" >
81+ An object containing any custom options.
6582
83+ <Expandable title = " options properties" >
84+ <ParamField body = ' [`key`: `string`]' type = ' "string" | "number" | "boolean" | "undefined"' >
85+ Additional data collected from the user.
6686</ParamField >
6787
6888</Expandable >
6989</ParamField >
90+ </ParamField >
7091
7192<ParamField body = ' getErrors' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/Error" >Error</a >[]</span >} >
7293
73- Retrieves the array of transaction errors from the context, or an empty array if none exist.
74-
75- An array of error objects from the transaction context.
94+ This method retrieves the array of transaction errors from the context, or an empty array if none exist.
7695
7796</ParamField >
7897
79- <ParamField body = ' selectPhoneNumber' type = ' Promise<void> ' >
98+ <ParamField body = ' selectPhoneNumber' type = ' (options ?) ' >
8099
81- Selects a phone number from the list of enrolled phone numbers.
82-
83- #### Throws
84-
85- If the index is out of bounds.
100+ This method selects a phone number from the list of enrolled phone numbers.
86101
87102``` typescript Example
88103import MfaSmsList from ' @auth0/auth0-acul-js/mfa-sms-list' ;
@@ -94,12 +109,18 @@ const selectPhoneNumber = async () => {
94109}
95110```
96111
97- <Expandable title = " Parameters" >
98- <ParamField body = ' payload?' type = { <span ><a href = " /docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsListOptions" >MfaSmsListOptions</a ></span >} >
99- ** Properties**
112+ <ParamField body = " options" type = " OPTIONAL" >
113+ Optional payload for the action.
100114
101- <ParamField body = ' index' type = ' number' />
115+ <Expandable title = " options properties" >
116+ <ParamField body = ' [`key`: `string`]' type = ' "string" | "number" | "boolean" | "undefined"' >
117+ Additional data collected from the user.
118+ </ParamField >
119+
120+ <ParamField body = ' index' type = ' number' >
121+ The index of the phone number to select.
102122</ParamField >
103123
104124</Expandable >
105- </ParamField >
125+ </ParamField >
126+ </ParamField >
0 commit comments