n2n Page Rocket 1 API

Methods summary

Methods in detail

• root

  PageUrlComposer public static root ( )
  Creates a PageUrlComposer which points to the root page of the current page according to PageState. If there is no current page any root page will be used.

  return

  PageUrlComposer

• navRoot

  PageUrlComposer public static navRoot ( )

  return

  PageUrlComposer

• current

  PageUrlComposer public static current ( )
  Creates a PageUrlComposer which points to the current page according to PageState. If there is no current page any root page will be used.

  return

  PageUrlComposer

• home

  PageUrlComposer public static home ( )

  param

  string subsystemName

  return

  PageUrlComposer

• subHome

  public static subHome ( string subsystemName = null )

• obj

  PageUrlComposer public static obj ( object obj )

  Creates a PageUrlComposer which points to a page which is affiliated with the passed object.

  You can use any object which is related to a page. For example an object of type NavBranch, Leaf, PageController etc.

  param

  object obj affiliated object

  return

  PageUrlComposer

• tag

  PageUrlComposer public static tag ( string tagNames )
  Creates a PageUrlComposer which points to a page which contains passed tags. See tags article for further information about tags.

  param

  string ...$tagNames ...$tagNames names of tags

  return

  PageUrlComposer

• hook

  PageUrlComposer public static hook ( string hookKeys )
  Creates a PageUrlComposer which points to a page which is marked with passed hooks. See hooks article for further information about hooks.

  param

  string ...$hookKeys ...$hookKeys keys of hooks

  return

  PageUrlComposer

• id

  PageUrlComposer public static id ( string id )

  param

  string id Page id

  return

  PageUrlComposer