Component:TOTP Dialog: Difference between revisions

Latest revision as of 19:51, 30 April 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.

Component image

File:TOTP DialogComponent.png

TOTP Dialog component as seen in the Scene Inspector

The TOTP_Dialog component, otherwise known as the temporary one time password Component, is used in the dash space for logging into Resonite via TOTP systems.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`_swapRegion`	SlideSwapRegion	The region slider for swapping between screens on this UI screen.
`_state`	TOTP_Dialog.State	The screen this is currently showing.
`_codeField`	TextField	The text field the accepts codes in the TOTP protocol.
`_messageText`	Text	The text element showing messages to the user.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`OnContinue:ButtonEventHandler`	ButtonEventHandler	✓	Handles when the user asks to continue.
`CopyCodesToClipboard:ButtonEventHandler`	ButtonEventHandler	✓	Handles when the user asks to copy TOTP codes to the clipboard.
`OnActivate:ButtonEventHandler`	ButtonEventHandler	✓	Handles when the user activates the method.
`OnDeactivate:ButtonEventHandler`	ButtonEventHandler	✓	Handles when the user deactivates the method.
`OnClose:ButtonEventHandler`	ButtonEventHandler	✓	Handles when the user closes the dialog

State

Values
Name	Value	Description
`Initializing`	0	Is currently on the initalizing screen.
`SetupAuth`	1	Is currently on the setup TOTP screen.
`SaveRecoveryCodes`	2	Is currently on the save recovery codes screen.
`Activate`	3	Is currently on the activate TOTP screen.
`Deactivate`	4	Is currently on the deactivates TOTP screen.
`Message`	5	Is currently on the submit TOTP screen.

Usage

Used in Temporary One Time Password setup.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 1: / Line 1: @@
+{{UserspaceComponent}}
 {{Infobox Component
 |Image=TOTP_DialogComponent.png
 |Name=TOTP Dialog
 }}
-{{stub}}
+The '''TOTP_Dialog''' component, otherwise known as the temporary one time password Component, is used in the dash space for logging into Resonite via TOTP systems.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|_swapRegion|'''[[Component:SlideSwapRegion|SlideSwapRegion]]'''|TypeAdv0=true|
+|_swapRegion|'''[[Component:SlideSwapRegion|SlideSwapRegion]]'''|TypeAdv0=true| The region slider for swapping between screens on this UI screen.
-|_state|'''[[#State|TOTP_Dialog.State]]'''|TypeAdv1=true|
+|_state|'''[[#State|TOTP_Dialog.State]]'''|TypeAdv1=true| The screen this is currently showing.
-|_codeField|'''[[Component:TextField|TextField]]'''|TypeAdv2=true|
+|_codeField|'''[[Component:TextField|TextField]]'''|TypeAdv2=true| The text field the accepts codes in the TOTP protocol.
-|_messageText|'''[[Component:Text|Text]]'''|TypeAdv3=true|
+|_messageText|'''[[Component:Text|Text]]'''|TypeAdv3=true| The text element showing messages to the user.
 }}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|OnContinue:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnContinue:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user asks to continue.
-|CopyCodesToClipboard:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|CopyCodesToClipboard:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user asks to copy TOTP codes to the clipboard.
-|OnActivate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnActivate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user activates the method.
-|OnDeactivate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnDeactivate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user deactivates the method.
-|OnClose:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnClose:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user closes the dialog
+}}
+== State ==
+{{Table EnumValues
+|Initializing|0| Is currently on the initalizing screen.
+|SetupAuth|1| Is currently on the setup TOTP screen.
+|SaveRecoveryCodes|2| Is currently on the  save recovery codes screen.
+|Activate|3| Is currently on the activate TOTP screen.
+|Deactivate|4| Is currently on the deactivates TOTP screen.
+|Message|5| Is currently on the submit TOTP screen.
 }}
-== Behavior ==
+== Usage ==
+Used in Temporary One Time Password setup.
 == Examples ==
+{{stub}}
 == See Also ==
@@ Line 31: / Line 44: @@
 [[Category:Components{{#translation:}}|TOTP Dialog]]
 [[Category:Components With Nested Enums{{#translation:}}|TOTP Dialog]]
-[[Category:ComponentStubs]]