@adobe/exc-app 0.2.44-test → 0.2.44

package/docs/interfaces/page.pageapi.md

@@ -27,6 +27,8 @@ Defines page-level APIs available to solutions.
 
 ### Methods
 
+* [afterPrintHandler](page.pageapi.md#afterprinthandler)
+* [beforePrintHandler](page.pageapi.md#beforeprinthandler)
 * [blockNavigation](page.pageapi.md#blocknavigation)
 * [clipboardWrite](page.pageapi.md#clipboardwrite)
 * [done](page.pageapi.md#done)
@@ -35,6 +37,7 @@ Defines page-level APIs available to solutions.
 * [iframeReload](page.pageapi.md#iframereload)
 * [notFound](page.pageapi.md#notfound)
 * [openInNewTab](page.pageapi.md#openinnewtab)
+* [print](page.pageapi.md#print)
 * [setModalQuerySelectors](page.pageapi.md#setmodalqueryselectors)
 * [shellRedirect](page.pageapi.md#shellredirect)
 
@@ -184,6 +187,52 @@ page.unloadPromptMessage = 'Are you sure you want to leave?';
 
 ## Methods
 
+### afterPrintHandler
+
+▸ **afterPrintHandler**(`callback`: [Callback](page.callback.md)): void
+
+A function that listens and handles the afterPrint event.
+
+```typescript
+***Example:***
+page.afterPrintHandler = function () {
+  // Revert temporary CSS changes
+};
+````
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`callback` | [Callback](page.callback.md) | The function that results in printing.  |
+
+**Returns:** void
+
+___
+
+### beforePrintHandler
+
+▸ **beforePrintHandler**(`callback`: [Callback](page.callback.md)): void
+
+A function that listens and handles the beforePrint event.
+
+```typescript
+***Example:***
+page.beforePrintHandler = function () {
+  // Temporary CSS changes, like unsetting height
+};
+````
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`callback` | [Callback](page.callback.md) | The function that results in printing.  |
+
+**Returns:** void
+
+___
+
 ### blockNavigation
 
 ▸ **blockNavigation**(`enabled`: boolean, `options?`: [BlockNavigationOptions](page.blocknavigationoptions.md)): void
@@ -309,7 +358,7 @@ ___
 
 ### getModalQuerySelectors
 
-▸ **getModalQuerySelectors**(): Array\<string>
+▸ **getModalQuerySelectors**(): Array<string\>
 
 Get the list of selectors presently being used by modalAutoDetect.
 
@@ -319,7 +368,7 @@ Get the list of selectors presently being used by modalAutoDetect.
 page.getModalQuerySelectors({path: '/abc'});
 ```
 
-**Returns:** Array\<string>
+**Returns:** Array<string\>
 
 The list of selectors presently being used by modalAutoDetect.
 
@@ -388,13 +437,41 @@ Name | Type | Description |
 
 ___
 
+### print
+
+▸ **print**(`callback`: [Callback](page.callback.md)): void
+
+A function to control printing. The callback function should call `window.print()`
+at some point. It's important that the callback not be an arrow function if you
+want the `window` object to be the iframe contents. Feel free to adjust your
+CSS or UI before `window.print()` and reverse those changes afterwards.
+
+```typescript
+***Example:***
+page.print = function () {
+  window.print();
+};
+````
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`callback` | [Callback](page.callback.md) | The function that results in printing.  |
+
+**Returns:** void
+
+___
+
 ### setModalQuerySelectors
 
-▸ **setModalQuerySelectors**(`selectors`: Array\<string>): void
+▸ **setModalQuerySelectors**(`selectors`: Array<string\>): void
 
 Set the list of selectors presently being used by modalAutoDetect. If set to an empty
 array, the default selectors used by runtime will be used instead. To stop observing changes
-unset modalAutoDetect.
+unset modalAutoDetect. Setting additonal selectors replaces the currently set selectors, use
+page.getModalQuerySelectors and append new selectors to the returned list before resetting
+to modify the existing list of selectors.
 
 ***Example:***
 
@@ -406,7 +483,7 @@ page.setModalQuerySelectors(['.someSpecialCaseModal', '.yourNormalModal']);
 
 Name | Type | Description |
 ------ | ------ | ------ |
-`selectors` | Array\<string> | The list of selectors for modalAutoDetect to use.  |
+`selectors` | Array<string\> | The list of selectors for modalAutoDetect to use.  |
 
 **Returns:** void
 

package/docs/interfaces/permissions.permissionsapi.md

@@ -20,7 +20,7 @@ APIs to get permissions. An app in unified shell can consume PALM ACL service.
 
 ### get
 
-▸ **get**\<T>(`params`: [Parameters](permissions.parameters.md)): Promise\<[PermissionsResponse](permissions.permissionsresponse.md)\<T>>
+▸ **get**<T\>(`params`: [Parameters](permissions.parameters.md)): Promise<[PermissionsResponse](permissions.permissionsresponse.md)<T\>\>
 
 Gets permissions based on the specified parameters.
 
@@ -36,6 +36,6 @@ Name | Type | Description |
 ------ | ------ | ------ |
 `params` | [Parameters](permissions.parameters.md) | Parameters used to identify permissions to retrieve. |
 
-**Returns:** Promise\<[PermissionsResponse](permissions.permissionsresponse.md)\<T>>
+**Returns:** Promise<[PermissionsResponse](permissions.permissionsresponse.md)<T\>\>
 
 A promise for the specified permissions.

package/docs/interfaces/permissions.permissionsresponse.md

@@ -2,7 +2,7 @@
 
 > [Globals](../README.md) / [permissions](../modules/permissions.md) / PermissionsResponse
 
-# Interface: PermissionsResponse\<T>
+# Interface: PermissionsResponse<T\>
 
 The response from the permissions service.
 

package/docs/interfaces/pulse.pulseapi.md

@@ -13,12 +13,14 @@
 ### Methods
 
 * [send](pulse.pulseapi.md#send)
+* [setButton](pulse.pulseapi.md#setbutton)
+* [setCount](pulse.pulseapi.md#setcount)
 
 ## Methods
 
 ### send
 
-▸ **send**(`notifications`: [PulseNotification](pulse.pulsenotification.md)[]): Promise\<[PulseResponse](pulse.pulseresponse.md)>
+▸ **send**(`notifications`: [PulseNotification](pulse.pulsenotification.md)[]): Promise<[PulseResponse](pulse.pulseresponse.md)\>
 
 Method to send a pulse notification.
 
@@ -28,4 +30,38 @@ Name | Type |
 ------ | ------ |
 `notifications` | [PulseNotification](pulse.pulsenotification.md)[] |
 
-**Returns:** Promise\<[PulseResponse](pulse.pulseresponse.md)>
+**Returns:** Promise<[PulseResponse](pulse.pulseresponse.md)\>
+
+___
+
+### setButton
+
+▸ **setButton**(`buttonConfig`: [PulseButtonConfig](pulse.pulsebuttonconfig.md)): void
+
+Adds an additional custom button to the bottom of the Pulse container.
+Will fire the attached callback when a user presses the button.
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`buttonConfig` | [PulseButtonConfig](pulse.pulsebuttonconfig.md) | The button configuration  |
+
+**Returns:** void
+
+___
+
+### setCount
+
+▸ **setCount**(`count`: number): void
+
+Adds additional values to the notification.
+If Pulse has 3 internally and this is set to 2, the UI will show 5.
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`count` | number | Additional values to add to the pulse notification.  |
+
+**Returns:** void

package/docs/interfaces/pulse.pulsebuttonconfig.md

@@ -0,0 +1,32 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [pulse](../modules/pulse.md) / PulseButtonConfig
+
+# Interface: PulseButtonConfig
+
+## Hierarchy
+
+* **PulseButtonConfig**
+
+## Index
+
+### Properties
+
+* [callback](pulse.pulsebuttonconfig.md#callback)
+* [label](pulse.pulsebuttonconfig.md#label)
+
+## Properties
+
+### callback
+
+• `Optional` **callback**: undefined \| (value?: any) => void
+
+Callback function to be automatically executed on click.
+
+___
+
+### label
+
+•  **label**: string
+
+Text of the button.

package/docs/interfaces/pulse.pulsenotification.md

@@ -39,7 +39,7 @@ ___
 
 ### metadata
 
-• `Optional` **metadata**: Record\<string, string>
+• `Optional` **metadata**: Record<string, string\>
 
 A map of key value pairs which can be provided by publisher of notification for the consumer.
 
@@ -55,7 +55,7 @@ ___
 
 ### templateParams
 
-•  **templateParams**: Record\<string, any>
+•  **templateParams**: Record<string, any\>
 
 Templated parameters.
 

package/docs/interfaces/root.modules.md

@@ -0,0 +1,161 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / Modules
+
+# Interface: Modules
+
+## Hierarchy
+
+* **Modules**
+
+## Index
+
+### Properties
+
+* [appApi](root.modules.md#appapi)
+* [capabilityApi](root.modules.md#capabilityapi)
+* [default](root.modules.md#default)
+* [helpCenter](root.modules.md#helpcenter)
+* [internal](root.modules.md#internal)
+* [metrics](root.modules.md#metrics)
+* [network](root.modules.md#network)
+* [nps](root.modules.md#nps)
+* [orgSwitcher](root.modules.md#orgswitcher)
+* [page](root.modules.md#page)
+* [permissions](root.modules.md#permissions)
+* [pulse](root.modules.md#pulse)
+* [runtime](root.modules.md#runtime)
+* [session](root.modules.md#session)
+* [settings](root.modules.md#settings)
+* [shell](root.modules.md#shell)
+* [sidebar](root.modules.md#sidebar)
+* [sidenav](root.modules.md#sidenav)
+* [topbar](root.modules.md#topbar)
+* [user](root.modules.md#user)
+* [userProfile](root.modules.md#userprofile)
+
+## Properties
+
+### appApi
+
+• `Readonly` **appApi**: () => [AppApi](appapi.appapi-1.md)
+
+___
+
+### capabilityApi
+
+• `Readonly` **capabilityApi**: () => [CapabilityApi](capabilityapi.capabilityapi-1.md)
+
+___
+
+### default
+
+• `Readonly` **default**: (options?: any) => [Runtime](root.runtime.md)
+
+___
+
+### helpCenter
+
+• `Readonly` **helpCenter**: [HelpCenterApi](helpcenter.helpcenterapi.md)
+
+___
+
+### internal
+
+• `Readonly` **internal**: InternalApi
+
+___
+
+### metrics
+
+• `Readonly` **metrics**: [MetricsApi](metrics.metricsapi.md)
+
+___
+
+### network
+
+• `Readonly` **network**: [NetworkApi](network.networkapi.md)
+
+___
+
+### nps
+
+• `Readonly` **nps**: [Nps](nps.nps-1.md)
+
+___
+
+### orgSwitcher
+
+• `Readonly` **orgSwitcher**: OrgSwitcherApi
+
+___
+
+### page
+
+• `Readonly` **page**: [PageApi](page.pageapi.md)
+
+___
+
+### permissions
+
+• `Readonly` **permissions**: () => [PermissionsApi](permissions.permissionsapi.md)
+
+___
+
+### pulse
+
+• `Readonly` **pulse**: () => [PulseApi](pulse.pulseapi.md)
+
+___
+
+### runtime
+
+•  **runtime**: [Runtime](root.runtime.md)
+
+___
+
+### session
+
+• `Readonly` **session**: () => [SessionApi](session.sessionapi.md)
+
+___
+
+### settings
+
+• `Readonly` **settings**: () => [SettingsApi](settings.settingsapi.md)
+
+___
+
+### shell
+
+• `Readonly` **shell**: () => [ShellApi](shell.shellapi.md)
+
+___
+
+### sidebar
+
+• `Readonly` **sidebar**: SidebarApi
+
+___
+
+### sidenav
+
+• `Readonly` **sidenav**: () => SidenavApi
+
+___
+
+### topbar
+
+• `Readonly` **topbar**: [TopbarApi](topbar.topbarapi.md)
+
+___
+
+### user
+
+• `Readonly` **user**: () => [UserApi](user.userapi.md)
+
+___
+
+### userProfile
+
+• `Readonly` **userProfile**: [UserProfileApi](userprofile.userprofileapi.md)

package/docs/interfaces/root.runtime.md

@@ -0,0 +1,102 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / Runtime
+
+# Interface: Runtime<T\>
+
+Defines the runtime object providing all unified-shell APIs for solution authors.
+
+## Type parameters
+
+Name | Default |
+------ | ------ |
+`T` | Record<string, any\\> |
+
+## Hierarchy
+
+* EventEmitter
+
+  ↳ **Runtime**
+
+## Index
+
+### EventEmitter Methods
+
+* [emit](root.runtime.md#emit)
+* [off](root.runtime.md#off)
+* [on](root.runtime.md#on)
+
+## EventEmitter Methods
+
+### emit
+
+▸ **emit**<K\>(`type`: K, `event?`: T[K]): void
+
+*Inherited from void*
+
+Invoke all handlers for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | The event type to invoke. |
+`event?` | T[K] | Any value (object is recommended and powerful), passed to each handler. |
+
+**Returns:** void
+
+___
+
+### off
+
+▸ **off**<K\>(`type`: K, `handler`: (event?: T[K]) => void): void
+
+*Inherited from void*
+
+Remove an event handler for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | Type of event to unregister `handler` from. |
+`handler` | (event?: T[K]) => void | Handler function to remove. |
+
+**Returns:** void
+
+___
+
+### on
+
+▸ **on**<K\>(`type`: K, `handler`: (event?: T[K]) => void): void
+
+*Inherited from void*
+
+Register an event handler for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | Type of event to listen for. |
+`handler` | (event?: T[K]) => void | Function to call in response to given event. |
+
+**Returns:** void