Apple TV Docs

Personal Commands

Login

This allow 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.

<menuItem rockCommand="login" 
    rockLoginPageGuid="0C64D387-0A87-ECAA-48A5-B38A62CC704C" 
    rockLoginTimeoutPageGuid="E6F3553B-6270-04AD-4882-F6A99FB3875D"
    rockLoginSuccessPageGuid="C1EAA112-B225-74AA-4F2D-3EA0E72560FE">
    <title>Login</title>
</menuItem>
ParameterTypeDescription
rockLoginPageGuidstringThis tells the shell where to navigate to to show the login information. This page will be passed a set of merge fields 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 listed of merge fields that will be passed to your login page. You can reference them in your page via { mergeFieldKey } (note the single braces not to be confused with Lava's double). Note that the keys are case sensitive.

KeyDescription
authCodeThe code that the individual will need to enter into the web based authorization page.
authQrCodeUrlThe URL to the QR code for authentication. This SVG code is generated by Rock.

Logout

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).