Global

Members

(constant) GenericBuildPipelineWorkerCheck :GenericBuildPipelineWorkerConstructor.<*, *, *, *>

Type:
  • GenericBuildPipelineWorkerConstructor.<*, *, *, *>
Source:

(constant) LoadServerSidePipelineWorkerCheck

Source:

(constant) QueueTest :QueueConstructor.<*>

Type:
  • QueueConstructor.<*>
Source:

(constant) StandardViewManagerCheck :StandardViewManagerConstructor.<*, *>

Type:
  • StandardViewManagerConstructor.<*, *>
Source:

(constant) UploadDataPipelineWorkerCheck

Source:

(constant) attrCheck :AttributesTransitionsWorkerConstructor

Type:
  • AttributesTransitionsWorkerConstructor
Source:

(constant) baseCheck

SPECIFYING TYPE AGAIN IS VERY IMPORTANT
Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check :AppMainFragmentConstructor

Type:
  • AppMainFragmentConstructor
Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Source:

(constant) check :TransitionsBaseWorkerConstructor

Type:
  • TransitionsBaseWorkerConstructor
Source:

(constant) check

Source:

(constant) check

Source:

(constant) check

Taking most design from previous controller
Source:

(constant) checkWorker

Source:

(constant) dataManager

Source:

(constant) workerTest

Source:

Methods

base()

Source:

completeCb(finalArgs)

Parameters:
Name Type Description
finalArgs ViewPanelsManagerConsentPipelineBuildArgs
Source:

completeCb(finalArgs)

Parameters:
Name Type Description
finalArgs ViewPanelLocalPipelineWorkerConsentArgs
Source:

generateRandomInteger(min, max)

Returns a random number between min and max, max excluded
Parameters:
Name Type Description
min Number
max Number
Deprecated:
  • Use RandomNumberCharGenUtils
Source:

getTos(stackObj) → {string}

Parameters:
Name Type Description
stackObj Object
Source:
Returns:
Type
string

(async) globalLoadAsyncFragment(cb, forFragment)

Loads the async fragment and pipes control to it
This:
  • {AppShellAsyncMainFragment
Parameters:
Name Type Description
cb asyncLoadCb
forFragment
Source:

intersectionCallback(onIntersectCallback, entries, observer)

Parameters:
Name Type Description
onIntersectCallback *
entries Array.<IntersectionObserverEntry>
observer *
Source:

mutationStateUpdate(id)

Parameters:
Name Type Description
id string Only expect one id here
Source:

mutationStateUpdate(id)

Parameters:
Name Type Description
id string Only expect one id here NOTE: APIScope is the finalScope.
Source:

mutationStateUpdate(id)

Parameters:
Name Type Description
id string Only expect one id here APIScope is the original scope
Source:

ofScope()

Source:

ofViews()

Source:

retryCb()

Source:

routeIsValid(route)

Parameters:
Name Type Description
route string
Source:

Type Definitions

ActiveBuildInfo

Properties:
Name Type Description
buildStack Stack.<AppMainFragmentInstance>
cancelBuildStack Stack.<AppMainFragmentInstance> * @typedef {ExtGenericRouteBuildPipelineArgs<{ routeParams: RouteParams, savedState: SavedFragmentState, buildStack: Stack }} BuildStatePipelineArgs
Source:

AppExtraOptions

Properties:
Name Type Description
linkInterceptor Object
Source:

AppHistoryState

The page history state
Type:
  • Object
Properties:
Name Type Description
pageTitle string
pageUrl string
stackEntry number to keep track of the number of state entries, and help distinguish between forward and back pops
Source:

AppRootView

This is the view that holds all fragments in the app and controls to operate these fragments Can be dynamically loaded to allow unique views per user class/type Combined with dynamically loading the fragments as needed, only parts of the app the current user class needs will be loaded from the view set at the app root. Use other access-control methods to ensure zero bypass by an advanced user such as validating requests for views on the server as well before rendering.
Type:
  • object
Properties:
Name Type Attributes Description
template string Inflated HTML template
mainNavInfos Array.<MainNavigationInfo> Navigation info for the root view to help with navigation state management
viewParentID string <optional>
 The parent ID the view will be attached to. If it's not provided, the view will be attached to the body
Source:

ConsentGivenInfo

Used to request consent for changing route from fragments. Fragments will ask attached view panels So, might be same base route but different query to change view panel, hosted by any fragment in tree, so need to ask if ok. Therefore, more fluid structure since view panels can be popped anywhere and consent if a simple param or query change Can be used for floating panels changing data based on param or query, used by specific fragment. Basically, better, more fluid design
Properties:
Name Type Description
fragment AppMainFragmentInstance
savedState SavedFragmentState
Source:

ConsentStackArgs

ALGO CHANGE. Everyone in changing route MUST consent, even if not necessarily being destroyed So, viewing routes as states. So, two routes with same nested frags might still be different states, and developer may want to consent the change in states So, below algo is new for populateDestroyStack? Yes...
Properties:
Name Type Description
prevTarget AppMainFragmentInstance
prevNestedChildFragments Array.<AppMainFragmentInstance>
Source:

FragmentBuildWorkerDestArgs

Properties:
Name Type Description
cb fragmentDestroyCb
jumpCall boolean Continue from here - LocalPipelineWorker and consenting to routes with overrides, potentially
Source:

HistoryStackData

Properties:
Name Type Description
routingInfo ExtendedRoutingInfo
clonedState SavedFragmentState
Source:

IndexedRouterHistory

The immediate history of the router
Type:
  • object
Properties:
Name Type Description
lastHistoryState AppHistoryState The last page history state
lastRouteEntry RoutingInfo The last routing info
deadHistoryNodeStartIndex number
Source:

InflatedTargetRouteEntryInfo

Inflates the target route entry
Type:
  • Object
Source:

InflationArgs

Properties:
Name Type Description
prevTarget AppMainFragmentInstance
currentInflatedNestedChildFragments Array.<AppMainFragmentInstance>
mainRouterInstance MainRouter
Source:

LocalFragmentRoutingInfo

Local routing information based on local navigation controls Use this to trigger buttons too? YES. Use startsWith to always work They call triggerNavigationalRouting(navBtnID). Can override to do sth custom. Calling super does the routing requested
Type:
  • object
Properties:
Name Type Description
route string The route the navigation button should request for
baseActiveRoute string The base route the navigation button should always be active for
navBtnID string The navigation button ID that triggers this route. One ID can only trigger one route. Enforced in builder
Source:

MainRouter

Type:
  • object
Properties:
Name Type Description
routeToView routeToView
appRootStateCallback appRootStateCallback
Source:

QueryParamsList

Working on it
Type:
  • object
Properties:
Name Type Description
params Array.<string>
queries Array.<string>
Source:

RemoteStateChangeCallbackOptions

Properties:
Name Type Description
id string
XMLHttpRequest XMLHttpRequest
successCallback remoteReqSuccessCb.<{}>
overrideStateCb overrideStateCb
Source:

RemoteStateChangeCallbackOptions

Properties:
Name Type Description
id string
XMLHttpRequest XMLHttpRequest
successCallback remoteReqSuccessCb.<{}>
overrideStateCb overrideStateCb
Source:

RouteBuildInfo

Type:
  • Object
Properties:
Name Type Description
targetRouteEntry RoutingInfo
fullURL string Complete URL for the route (params and queries included)
routeBuildPipelineDataArgs routeBuildPipelineDataArgs.<{}>
popEvent Object
skipConsentFromCancel boolean
inflationOverhaul boolean Whether the whole targetRouteEntry is to be inflated
childDiffIndex number
inflatedTarget AppMainFragmentInstance
inflatedNestedChildFragments Array.<AppChildFragmentInstance>
fullURL string
inflatedRoutingInfo InflatedRoutingInfo
savedState SavedFragmentState
Source:

StandardRemoteRequestUtils

Type:
  • StandardRemoteRequestUtilsInstance
Source:

ViewPanelBuildArgs

New Way to build view panel. Other option by name is deprecated
Type:
  • Object
Source:

ViewPanelBuildStateArgs

Type:
  • GenericViewPanelBuildStateArgs.<null>
Source:

ViewPanelLocalPipelineWorkerDFAGroups

Type:
  • Object
Source:

ViewPanelsManagerDFAGroups

Type:
  • Object
Source:

appRootStateCallback(state)

Parameters:
Name Type Description
state AppHistoryState
Source:

buildViewPanel() → {FragmentLifeCycleInstance}

Properties:
Name Type Description
requestRoute genericThrowsParamFunction.<string, string>
getFragmentLifeCycleManager getFragmentLifeCycleManager BETTER WAY OF DEFINING METHODS AND ANNOTATE IN CLASS USING /**@type ***
Source:
Returns:
Type
FragmentLifeCycleInstance

canAccessRoute(route) → {Promise.<RoutePipelineAccessValidator>}

Routing information for the app
Parameters:
Name Type Description
route string
Properties:
Name Type Attributes Description
route string The route valid for this entry
target AppFragmentBuilder The main fragment that starts this route
nestedChildFragments Array.<AppFragmentBuilder> The child fragments targeted for this route, in a nested order
baseNavBtn string <optional>
 (Auto-generated - so remove? I think YES) base navigational button for this route. Auto generated from the MainNavigationInfo
pageTitle string <optional>
 (Optional) The title of the current routed page. {Allow to pass when requesting routing} For managing access to a route internally
canAccess boolean
fallbackRoute string
Source:
Returns:
Whether the route can be accessed or not and fallback route if access denied.
Type
Promise.<RoutePipelineAccessValidator>

genericFunction() → {void}

Source:
Returns:
Type
void

genericParamFunction(param) → {void}

Parameters:
Name Type Description
param P
Source:
Returns:
Type
void

genericParamReturnFunction(param) → {R}

Parameters:
Name Type Description
param P
Source:
Returns:
Type
R

genericReturnFunction() → {T}

Source:
Returns:
Type
T

genericThrowsParamFunction(param) → {void}

Parameters:
Name Type Description
param P
Source:
Throws:
E
Returns:
Type
void

initViewBuilderCb

Type:
  • GenericFragmentBuilderStageArgs.<null>
Source: