Application Screen ^v2.7.212

Returns an ApplicationScreen object from the application screens object.

Application Screen Object

Methods

• id()

  Returns the screen id as a string.

• title()

  Returns the screen title as a string.

• page()

  Returns the configured page id as a string.

• route()

  Returns the screen route as a string.

• header()

  Returns the header page id as a string.

• footer()

  Returns the footer page id as a string.

• pageType()

  Returns the configured page type as a string.

• pageName()

  Returns the configured page name as a string.

• setTitle(title)

  Updates the screen title.

  • title (string): The new title.

• setPage(type, id)

  Updates the page assignment for the screen.

  • type (string): The page type. Valid values are "workview", "card", "page".
  • id (string): The page id.

• setRoute(route)

  Updates the screen route.

  • route (string): The new route.

• setHeader(header)

  Updates the screen header.

  • header (string): The new header value.

• setFooter(footer)

  Updates the screen footer.

  • footer (string): The new footer value.

• setHomepage()

  Marks this screen as the application homepage.

• remove()

  Removes this screen from the application and returns true if the screen was removed, otherwise false.

• json()

  Returns the screen as an object.

Examples

var app = security.application("My Application");
var screen = app.screens.get("Planner");

screen.setHomepage();

console.log(screen.json());