@govflanders/vl-widget-global-header-types 2.0.13 → 2.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/access-menu.d.ts +43 -1
- package/docs/functions/bootstrap.html +1 -1
- package/docs/interfaces/AccessMenuMethods.html +11 -11
- package/docs/interfaces/AlertConfig.html +4 -4
- package/docs/interfaces/Application.html +4 -4
- package/docs/interfaces/ApplicationMenuLink.html +5 -5
- package/docs/interfaces/Authorization.html +4 -4
- package/docs/interfaces/BUR.html +5 -5
- package/docs/interfaces/BaseEntity.html +4 -4
- package/docs/interfaces/BrandingConfigColors.html +3 -3
- package/docs/interfaces/BrandingConfigHost.html +5 -5
- package/docs/interfaces/BrandingConfigUmbrella.html +4 -4
- package/docs/interfaces/BrandingMethods.html +12 -12
- package/docs/interfaces/Channel.html +11 -11
- package/docs/interfaces/ContactMethods.html +8 -8
- package/docs/interfaces/ContactOption.html +15 -15
- package/docs/interfaces/ContactOptionRef.html +4 -4
- package/docs/interfaces/EA.html +4 -4
- package/docs/interfaces/EnrichedServicePoints.html +5 -5
- package/docs/interfaces/GID.html +4 -4
- package/docs/interfaces/GlobalHeaderClient.html +8 -8
- package/docs/interfaces/IDPData.html +4 -4
- package/docs/interfaces/Image.html +4 -4
- package/docs/interfaces/LB.html +4 -4
- package/docs/interfaces/Link.html +3 -3
- package/docs/interfaces/LinkWithTarget.html +4 -4
- package/docs/interfaces/MainLink.html +5 -5
- package/docs/interfaces/OV.html +4 -4
- package/docs/interfaces/ProfileConfig.html +7 -7
- package/docs/interfaces/ServicePoints.html +5 -5
- package/docs/interfaces/Session.html +2 -2
- package/docs/interfaces/User.html +3 -3
- package/docs/interfaces/VER.html +4 -4
- package/docs/types/AlertModifier.html +1 -1
- package/docs/types/BrandingConfigLevel.html +1 -1
- package/docs/types/CapacityCode.html +1 -1
- package/docs/types/ChannelIcon.html +1 -1
- package/docs/types/ChannelType.html +1 -1
- package/docs/types/CobrowseChannel.html +1 -1
- package/docs/types/ContactOptionSocialPlatform.html +1 -1
- package/docs/types/ContactServiceEndpoints.html +1 -1
- package/docs/types/EnrichedServicePoint.html +1 -1
- package/docs/types/Entity.html +1 -1
- package/docs/types/ServicePoint.html +1 -1
- package/package.json +1 -1
|
@@ -38,7 +38,49 @@ export interface AccessMenuMethods {
|
|
|
38
38
|
* @param profileConfig The profile configuration to set
|
|
39
39
|
* @returns The result of the operation
|
|
40
40
|
* @example
|
|
41
|
-
*
|
|
41
|
+
* // Simple example
|
|
42
|
+
* const successSimple = await globalHeaderClient.accessMenu.setProfile({ active: true, loginUrl: '/login', logoutUrl: '/logout' });
|
|
43
|
+
*
|
|
44
|
+
* // Complex example with IDP data and multiple identities
|
|
45
|
+
* const successComplex = await globalHeaderClient.accessMenu.setProfile({
|
|
46
|
+
* active: true,
|
|
47
|
+
* loginUrl: 'https://login.url.be',
|
|
48
|
+
* logoutUrl: 'https://logout.url.be',
|
|
49
|
+
* switchCapacityUrl: 'https://switchcapacity.url.be',
|
|
50
|
+
* idpData: {
|
|
51
|
+
* user: {
|
|
52
|
+
* firstName: 'John',
|
|
53
|
+
* name: 'Doe',
|
|
54
|
+
* },
|
|
55
|
+
* loginHint: 'user-login-hint',
|
|
56
|
+
* identities: [
|
|
57
|
+
* {
|
|
58
|
+
* user: {
|
|
59
|
+
* firstName: 'John',
|
|
60
|
+
* name: 'Doe',
|
|
61
|
+
* },
|
|
62
|
+
* onBehalfOf: {
|
|
63
|
+
* firstName: 'Jane',
|
|
64
|
+
* name: 'Smith',
|
|
65
|
+
* code: 'BUR',
|
|
66
|
+
* },
|
|
67
|
+
* loginHint: 'identity1-login-hint',
|
|
68
|
+
* },
|
|
69
|
+
* {
|
|
70
|
+
* user: {
|
|
71
|
+
* firstName: 'Alice',
|
|
72
|
+
* name: 'Johnson',
|
|
73
|
+
* },
|
|
74
|
+
* onBehalfOf: {
|
|
75
|
+
* identifier: 'BE04987987987',
|
|
76
|
+
* name: 'Company XYZ',
|
|
77
|
+
* code: 'EA',
|
|
78
|
+
* },
|
|
79
|
+
* loginHint: 'identity2-login-hint',
|
|
80
|
+
* },
|
|
81
|
+
* ],
|
|
82
|
+
* },
|
|
83
|
+
* });
|
|
42
84
|
*/
|
|
43
85
|
setProfile: (profileConfig: Partial<ProfileConfig>) => Promise<boolean>;
|
|
44
86
|
/**
|
|
@@ -5,4 +5,4 @@
|
|
|
5
5
|
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="bootstrap" class="tsd-anchor"></a><span class="tsd-kind-call-signature">bootstrap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GlobalHeaderClient.html" class="tsd-signature-type tsd-kind-interface">GlobalHeaderClient</a><span class="tsd-signature-symbol">></span><a href="#bootstrap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The entry URL which has a form like this:
|
|
6
6
|
<code>https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/your-widget-id/entry</code></p>
|
|
7
7
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GlobalHeaderClient.html" class="tsd-signature-type tsd-kind-interface">GlobalHeaderClient</a><span class="tsd-signature-symbol">></span></h4><p>The GlobalHeaderClient object.</p>
|
|
8
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
8
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/bootstrap.ts#lines-21">global-header-types/src/bootstrap.ts:21</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Global Header</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccessMenuMethods | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="AccessMenuMethods.html">AccessMenuMethods</a></li></ul><h1>Interface AccessMenuMethods</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AccessMenuMethods</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#addapplicationmenulink">addApplicationMenuLink</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">link</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#addapplicationmenulinks">addApplicationMenuLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#getapplicationname">getApplicationName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#getprofile">getProfile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setapplicationmenulinks">setApplicationMenuLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setapplicationname">setApplicationName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">applicationName</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setmainlinks">setMainLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mainLinks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setprofile">setProfile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profileConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setvisibility">setVisibility</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visibility</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/access-menu.ts#lines-4">global-header-types/src/client/access-menu.ts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="AccessMenuMethods.html#addapplicationmenulink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Application<wbr/>Menu<wbr/>Link</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccessMenuMethods | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="AccessMenuMethods.html">AccessMenuMethods</a></li></ul><h1>Interface AccessMenuMethods</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AccessMenuMethods</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#addapplicationmenulink">addApplicationMenuLink</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">link</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#addapplicationmenulinks">addApplicationMenuLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#getapplicationname">getApplicationName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#getprofile">getProfile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setapplicationmenulinks">setApplicationMenuLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setapplicationname">setApplicationName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">applicationName</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setmainlinks">setMainLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mainLinks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setprofile">setProfile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profileConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AccessMenuMethods.html#setvisibility">setVisibility</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visibility</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-4">global-header-types/src/client/access-menu.ts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="AccessMenuMethods.html#addapplicationmenulink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Application<wbr/>Menu<wbr/>Link</span></a>
|
|
2
2
|
<a href="AccessMenuMethods.html#addapplicationmenulinks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Application<wbr/>Menu<wbr/>Links</span></a>
|
|
3
3
|
<a href="AccessMenuMethods.html#getapplicationname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Application<wbr/>Name</span></a>
|
|
4
4
|
<a href="AccessMenuMethods.html#getprofile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Profile</span></a>
|
|
@@ -13,50 +13,50 @@
|
|
|
13
13
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">updatedLinks</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">addApplicationMenuLink</span><span class="hl-2">({ </span><span class="hl-7">label:</span><span class="hl-2"> </span><span class="hl-11">'Dashboard'</span><span class="hl-2">, </span><span class="hl-7">href:</span><span class="hl-2"> </span><span class="hl-11">'/dashboard'</span><span class="hl-2"> });</span>
|
|
14
14
|
</code><button type="button">Copy</button></pre>
|
|
15
15
|
|
|
16
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
16
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-21">global-header-types/src/client/access-menu.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="addapplicationmenulinks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Application<wbr/>Menu<wbr/>Links</span><a href="#addapplicationmenulinks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">addApplicationMenuLinks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Add multiple application menu links</p>
|
|
17
17
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="addapplicationmenulinks__type-1"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">links</span>: <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The application menu links to add</p>
|
|
18
18
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The updated list of application menu links</p>
|
|
19
19
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-1" class="tsd-anchor"></a>Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">updatedLinks</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">addApplicationMenuLinks</span><span class="hl-2">([{ </span><span class="hl-7">label:</span><span class="hl-2"> </span><span class="hl-11">'Profile'</span><span class="hl-2">, </span><span class="hl-7">href:</span><span class="hl-2"> </span><span class="hl-11">'/profile'</span><span class="hl-2"> }]);</span>
|
|
20
20
|
</code><button type="button">Copy</button></pre>
|
|
21
21
|
|
|
22
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
22
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-30">global-header-types/src/client/access-menu.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getapplicationname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Application<wbr/>Name</span><a href="#getapplicationname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getApplicationName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the application name</p>
|
|
23
23
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getapplicationname__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>The application name</p>
|
|
24
24
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-2" class="tsd-anchor"></a>Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">appName</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">getApplicationName</span><span class="hl-2">();</span>
|
|
25
25
|
</code><button type="button">Copy</button></pre>
|
|
26
26
|
|
|
27
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
27
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-106">global-header-types/src/client/access-menu.ts:106</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getprofile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Profile</span><a href="#getprofile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getProfile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the profile configuration</p>
|
|
28
28
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getprofile__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The profile configuration</p>
|
|
29
29
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-3" class="tsd-anchor"></a>Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">profile</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">getProfile</span><span class="hl-2">();</span>
|
|
30
30
|
</code><button type="button">Copy</button></pre>
|
|
31
31
|
|
|
32
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
32
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-98">global-header-types/src/client/access-menu.ts:98</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setapplicationmenulinks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Application<wbr/>Menu<wbr/>Links</span><a href="#setapplicationmenulinks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setApplicationMenuLinks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set all application menu links</p>
|
|
33
33
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setapplicationmenulinks__type-1"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">links</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">links</span>: <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The application menu links to set</p>
|
|
34
34
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="ApplicationMenuLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationMenuLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The updated list of application menu links</p>
|
|
35
35
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-4" class="tsd-anchor"></a>Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">updatedLinks</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setApplicationMenuLinks</span><span class="hl-2">([{ </span><span class="hl-7">label:</span><span class="hl-2"> </span><span class="hl-11">'Settings'</span><span class="hl-2">, </span><span class="hl-7">href:</span><span class="hl-2"> </span><span class="hl-11">'/settings'</span><span class="hl-2"> }]);</span>
|
|
36
36
|
</code><button type="button">Copy</button></pre>
|
|
37
37
|
|
|
38
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
38
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-39">global-header-types/src/client/access-menu.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setapplicationname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Application<wbr/>Name</span><a href="#setapplicationname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setApplicationName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">applicationName</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the application name</p>
|
|
39
39
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setapplicationname__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">applicationName</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">applicationName</span>: <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The application name to set</p>
|
|
40
40
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>The result of the operation</p>
|
|
41
41
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-5" class="tsd-anchor"></a>Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setApplicationName</span><span class="hl-2">(</span><span class="hl-11">'My Application'</span><span class="hl-2">);</span>
|
|
42
42
|
</code><button type="button">Copy</button></pre>
|
|
43
43
|
|
|
44
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
44
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-115">global-header-types/src/client/access-menu.ts:115</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setmainlinks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Main<wbr/>Links</span><a href="#setmainlinks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setMainLinks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mainLinks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the main links</p>
|
|
45
45
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setmainlinks__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mainLinks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mainLinks</span>: <a href="../types/Translatable.html" class="tsd-signature-type tsd-kind-type-alias">Translatable</a><span class="tsd-signature-symbol"><</span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The main links to set</p>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>The result of the operation</p>
|
|
47
47
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-6" class="tsd-anchor"></a>Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setMainLinks</span><span class="hl-2">([{ </span><span class="hl-7">label:</span><span class="hl-2"> </span><span class="hl-11">'Home'</span><span class="hl-2">, </span><span class="hl-7">href:</span><span class="hl-2"> </span><span class="hl-11">'/'</span><span class="hl-2">, </span><span class="hl-7">isExternal:</span><span class="hl-2"> </span><span class="hl-9">false</span><span class="hl-2"> }]);</span>
|
|
48
48
|
</code><button type="button">Copy</button></pre>
|
|
49
49
|
|
|
50
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
50
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-12">global-header-types/src/client/access-menu.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setprofile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Profile</span><a href="#setprofile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setProfile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profileConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the profile configuration</p>
|
|
51
51
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setprofile__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profileConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">profileConfig</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ProfileConfig.html" class="tsd-signature-type tsd-kind-interface">ProfileConfig</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The profile configuration to set</p>
|
|
52
52
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>The result of the operation</p>
|
|
53
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-7" class="tsd-anchor"></a>Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">
|
|
53
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-7" class="tsd-anchor"></a>Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// Simple example</span><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">successSimple</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setProfile</span><span class="hl-2">({ </span><span class="hl-7">active:</span><span class="hl-2"> </span><span class="hl-9">true</span><span class="hl-2">, </span><span class="hl-7">loginUrl:</span><span class="hl-2"> </span><span class="hl-11">'/login'</span><span class="hl-2">, </span><span class="hl-7">logoutUrl:</span><span class="hl-2"> </span><span class="hl-11">'/logout'</span><span class="hl-2"> });</span><br/><br/><span class="hl-5">// Complex example with IDP data and multiple identities</span><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">successComplex</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setProfile</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-7">active:</span><span class="hl-2"> </span><span class="hl-9">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">loginUrl:</span><span class="hl-2"> </span><span class="hl-11">'https://login.url.be'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">logoutUrl:</span><span class="hl-2"> </span><span class="hl-11">'https://logout.url.be'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">switchCapacityUrl:</span><span class="hl-2"> </span><span class="hl-11">'https://switchcapacity.url.be'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">idpData:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">user:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">firstName:</span><span class="hl-2"> </span><span class="hl-11">'John'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">name:</span><span class="hl-2"> </span><span class="hl-11">'Doe'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-7">loginHint:</span><span class="hl-2"> </span><span class="hl-11">'user-login-hint'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">identities:</span><span class="hl-2"> [</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">user:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">firstName:</span><span class="hl-2"> </span><span class="hl-11">'John'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">name:</span><span class="hl-2"> </span><span class="hl-11">'Doe'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-7">onBehalfOf:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">firstName:</span><span class="hl-2"> </span><span class="hl-11">'Jane'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">name:</span><span class="hl-2"> </span><span class="hl-11">'Smith'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">code:</span><span class="hl-2"> </span><span class="hl-11">'BUR'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-7">loginHint:</span><span class="hl-2"> </span><span class="hl-11">'identity1-login-hint'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">user:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">firstName:</span><span class="hl-2"> </span><span class="hl-11">'Alice'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">name:</span><span class="hl-2"> </span><span class="hl-11">'Johnson'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-7">onBehalfOf:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">identifier:</span><span class="hl-2"> </span><span class="hl-11">'BE04987987987'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">name:</span><span class="hl-2"> </span><span class="hl-11">'Company XYZ'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">code:</span><span class="hl-2"> </span><span class="hl-11">'EA'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-7">loginHint:</span><span class="hl-2"> </span><span class="hl-11">'identity2-login-hint'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> ],</span><br/><span class="hl-2"> },</span><br/><span class="hl-2">});</span>
|
|
54
54
|
</code><button type="button">Copy</button></pre>
|
|
55
55
|
|
|
56
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
56
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-90">global-header-types/src/client/access-menu.ts:90</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setvisibility" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Visibility</span><a href="#setvisibility" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setVisibility</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visibility</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the visibility of the access menu</p>
|
|
57
57
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setvisibility__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visibility</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">visibility</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The visibility to set</p>
|
|
58
58
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>The result of the operation</p>
|
|
59
59
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-8" class="tsd-anchor"></a>Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setVisibility</span><span class="hl-2">(</span><span class="hl-9">true</span><span class="hl-2">);</span>
|
|
60
60
|
</code><button type="button">Copy</button></pre>
|
|
61
61
|
|
|
62
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
62
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/client/access-menu.ts#lines-124">global-header-types/src/client/access-menu.ts:124</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#addapplicationmenulink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Application<wbr/>Menu<wbr/>Link</span></a><a href="#addapplicationmenulinks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Application<wbr/>Menu<wbr/>Links</span></a><a href="#getapplicationname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Application<wbr/>Name</span></a><a href="#getprofile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Profile</span></a><a href="#setapplicationmenulinks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Application<wbr/>Menu<wbr/>Links</span></a><a href="#setapplicationname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Application<wbr/>Name</span></a><a href="#setmainlinks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Main<wbr/>Links</span></a><a href="#setprofile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Profile</span></a><a href="#setvisibility" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Visibility</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Global Header</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AlertConfig | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="AlertConfig.html">AlertConfig</a></li></ul><h1>Interface AlertConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the configuration for the alert bar displayed on top of the header widget.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AlertConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AlertConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AlertConfig.html#message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AlertConfig.html#modifier">modifier</a><span class="tsd-signature-symbol">:</span> <a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AlertConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AlertConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AlertConfig.html#message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AlertConfig.html#modifier">modifier</a><span class="tsd-signature-symbol">:</span> <a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/alert.ts#lines-6">global-header-types/src/alert.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="AlertConfig.html#enabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled</span></a>
|
|
3
3
|
<a href="AlertConfig.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
4
4
|
<a href="AlertConfig.html#modifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modifier</span></a>
|
|
5
5
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="enabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enabled</span><a href="#enabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Shows or hides the alert bar on top of the header widget.</p>
|
|
6
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
8
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/alert.ts#lines-10">global-header-types/src/alert.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The content of the alert. This can be an HTML string.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/alert.ts#lines-15">global-header-types/src/alert.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="modifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>modifier</span><a href="#modifier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">modifier</span><span class="tsd-signature-symbol">:</span> <a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a></div><div class="tsd-comment tsd-typography"><p>Changes the icon and color of the alert.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/1d35bb303600b7ca5891141e48bd82cd21e4d165/packages/global-header-types/src/alert.ts#lines-20">global-header-types/src/alert.ts:20</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#enabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#modifier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modifier</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Global Header</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|