Skip to content
This repository has been archived by the owner on Mar 28, 2023. It is now read-only.

Latest commit

 

History

History
39 lines (24 loc) · 1.24 KB

runtime.flow_service.md

File metadata and controls

39 lines (24 loc) · 1.24 KB
Raw

flow_service

Module providing the FlowService factory.

To access the FlowService in a widget, request the axFlowService injection.

Contents

Types

Types

FlowService

Allows widgets to create valid URLs without knowledge about the current place, its routing patterns, or about the actual routing implementation.

FlowService.constructAbsoluteUrl( targetOrPlace, optionalParameters )

Constructs an absolute URL to the given target or place using the given parameters. If a target is given as first argument, it is resolved using the currently active place.

Parameters
Property Type Description
targetOrPlace String the target or place ID to construct a URL for
optionalParameters Object optional map of place parameters. Missing parameters are filled base on the parameters that were passed to the currently active place
Returns
Type Description
String the generated absolute URL