Web SDK documentation
  1. Injectables
  2. DocsService

File

core/docs/docs.service.ts

Index

Properties
Methods
Accessors

Constructor

constructor(options: OptionsService, app: AppStateService, injector: Injector, router: Router)
Parameters :
Name Type Optional
options OptionsService No
app AppStateService No
injector Injector No
router Router No

Methods

get
get()
Returns : any
getBaseUrl
getBaseUrl(uiVersion?: string | literal type)
Parameters :
Name Type Optional
uiVersion string | literal type Yes
Returns : string
getUrlWithDocsVersion
getUrlWithDocsVersion(url: string, uiVersion: string | literal type)

Takes a URL and replaces all {{ version }} placeholders with the relevant docs version (the version is derived from the app state or from the provided parameter).

Parameters :
Name Type Optional Default value Description
url string No

Any URL that contains {{ version }} placeholders.
uiVersion string | literal type No this.app.uiVersion

A version string or object, defaults to the app state version.
Returns : string

The URL with replaced {{ version }} placeholders.
getUserGuideLink
getUserGuideLink(link)
Parameters :
Name Optional
link No
Returns : any
list
list()
Returns : any
refresh
refresh()
Returns : void

Properties

Readonly DEFAULT_DOCS_BASE_URL
Type : string
Default value : 'https://www.cumulocity.com/guides/{{ version }}'

Default documentation URL.
factories
Type : DocLinkExtension[]
Default value : []

Additional factories that can be added by plugins.
items$
Type : Observable<DocLink[]>
Readonly refreshTrigger
Default value : new Subject()

Refresh the extension factories subject.

Accessors

templateStr
gettemplateStr()

results matching ""

    No results matching ""