👋 Roku Docs› ⚡ Commands›

Personal

Commands that relate to the Current Person.

Login

Allows for an individual to login to the TV Application.

Important

Be sure that your application has defined a Login page before using this command. That setting is used to configure the QR code.

<Rock:Button rockCommand="login" 
    rockLoginPageGuid="0C64D387-0A87-ECAA-48A5-B38A62CC704C" 
    rockLoginTimeoutPageGuid="E6F3553B-6270-04AD-4882-F6A99FB3875D"
    rockLoginSuccessPageGuid="C1EAA112-B225-74AA-4F2D-3EA0E72560FE"
    text="Login">
</Rock:Button>
ParameterTypeDescription
rockLoginPageGuidstringThis tells the shell where to navigate to show the login information. This page will be passed a set of custom values which are documented below.
rockLoginTimeoutPageGuidstringThe page to display after the login period expires.
rockLoginSuccessPageGuidstringThe page to display after a successful login. Consider displaying a personalized welcome to navigate back to the homepage.
rockLoginTimeoutDurationintThe amount of time in seconds (default to 600, 10 mins) that the login will wait until it times out.
rockLoginCheckDurationintThe number of seconds between the requests to the server to check to see if the authentication has completed (default 5 seconds).
rockLoginClearNavigationStackboolDetermines if the navigation stack should be cleared after successfully logging in. This ensures that if the individual hits back that it does not show impersonalized information (default true).

Below is a list of IDs that can be accessed in SceneGraph. Due to platform limitations, we couldn't really use merge fields.

KeyDescription
lgnQrPoster  When navigating to the login page, the application searches for a view with this ID and sets the uri to the login page, appending the verification code.  
lgnCodeLabel  When navigating to the login page, the application searches for a view with this ID and sets the text to the verification code.  

This allows for a person to logout from the app.

ParameterTypeDescription
rockLogoutPageGuidstringThe GUID of the page to show once the person has been logged out.
rockLogoutClearNavigationStackboolDetermines if the navigation stack should be cleared before logging out (default true).
Utility 📚 Resources