UNPKG

@microsoft/windows-admin-center-sdk

Version:

Microsoft - Windows Admin Center Shell

1 lines 3.03 kB
{"version":3,"sources":["../../../packages/core/notification/client-notification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;GAEG;AACH,oBAAY,sBAAsB;IAC9B;;OAEG;IACH,kBAAkB,IAAA;IAElB;;;;;OAKG;IACH,QAAQ,IAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,iBAAiB,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACnC","file":"client-notification.d.ts","sourcesContent":["import { NotificationLinkType } from './notification-link-type';\r\nimport { NotificationState } from './notification-state';\r\n\r\n/**\r\n * Type definition of Client Notification.\r\n */\r\nexport enum ClientNotificationType {\r\n /**\r\n * Display at the notification center. Using the ID, it can update the single notification.\r\n */\r\n NotificationCenter,\r\n\r\n /**\r\n * @deprecated\r\n *\r\n * All notification should go through NotificationCenter\r\n * Display as alert bar. ID will be ignored, and doesn't retain the notification instance and state.\r\n */\r\n AlertBar\r\n}\r\n\r\n/**\r\n * The notification produced by the client code as instant notification.\r\n */\r\nexport interface ClientNotification {\r\n /**\r\n * @deprecated\r\n * There is no longer a distinction between NotificationCenter and AlertBar notifications\r\n */\r\n type?: ClientNotificationType;\r\n\r\n /**\r\n * The session id (or instance id).\r\n */\r\n id: string;\r\n\r\n /**\r\n * The state of notification.\r\n */\r\n state: NotificationState;\r\n\r\n /**\r\n * The title of work item to display user. (localized)\r\n */\r\n title: string;\r\n\r\n /**\r\n * @deprecated\r\n *\r\n * This field can be removed\r\n */\r\n description?: string;\r\n\r\n /**\r\n * The message. (localized)\r\n */\r\n message: string;\r\n\r\n /**\r\n * Possible solution to address error. (localized)\r\n */\r\n solutionMessage?: string;\r\n\r\n /**\r\n * The success link to navigate to the object view. (optional)\r\n * At default, it brings to the home page of the module.\r\n * The path is relative to from the manifest opened point unless linkType is specified\r\n */\r\n link?: string;\r\n\r\n /**\r\n * The text to show up on the notification link text ex: \"Go to <linkText> on sme-xyz.domain.com\"\r\n * By default the text will be the auto detected source name like \"Files\"\r\n */\r\n linkText?: string;\r\n\r\n /**\r\n * the type of notification link. Default behavior is RelativeToTool\r\n */\r\n linkType?: NotificationLinkType;\r\n}\r\n"]}