Class Notification

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<NotificationConfig>
- Notification

Implements

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _autoCloseTimeoutId

_autoCloseTimeoutId: number

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnKeypress

_eventOnKeypress: Generic

`Private` _eventType

_eventType: string

`Private` _focusManagerInstance

_focusManagerInstance: FocusManager

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _gestureEventInstance

_gestureEventInstance: SwipeEvent

`Private` _hasGestureEvents

_hasGestureEvents: boolean

`Private` _isOpen

_isOpen: boolean

`Private` _parentSelf

_parentSelf: HTMLElement

`Private` _platformEventOnToggle

_platformEventOnToggle: OSFramework.OSUI.Patterns.Notification.Callbacks.OSOnToggleEvent

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
Inherited from AbstractPattern.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected` unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of INotification.equalsToID

Inherited from AbstractPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Private` _autoCloseNotification

_autoCloseNotification(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:44

`Private` _clickCallback

_clickCallback(e: MouseEvent): void
Parameters
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:51

`Private` _handleFocusBehavior

_handleFocusBehavior(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:57

`Private` _handleGestureEvents

_handleGestureEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:68

`Private` _hideNotification

_hideNotification(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:85

`Private` _keypressCallback

_keypressCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:113

`Private` _removeEvents

_removeEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:123

`Private` _showNotification

_showNotification(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:129

`Private` _triggerOnToggleEvent

_triggerOnToggleEvent(isOpen: boolean): void
Parameters
- isOpen: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:160

`Private` _updateA11yProperties

_updateA11yProperties(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:165

`Private` _updateCloseAfterTime

_updateCloseAfterTime(value: number): void
Parameters
- value: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:185

`Private` _updateInteractToClose

_updateInteractToClose(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:193

`Private` _updatePosition

_updatePosition(position: string): void
Parameters
- position: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:207

`Private` _updateWidth

_updateWidth(width: string): void
Parameters
- width: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:220

`Protected` clearTimeouts

clearTimeouts(): void
Protected
Method to clear timeouts

Memberof
Notification

Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:235

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method to set the A11Y properties when the pattern is built.

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:247

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the callbacks to be used in the pattern.

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:264

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the html references that will be used to manage the cssClasses and atribute properties

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:275

`Protected` setInitialStates

setInitialStates(): void
Protected
Method to set the cssClasses that should be assigned to the element on it's initialization

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:285

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove all assigned callbacks

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:314

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to reassign the HTML elements to undefined, preventing memory leaks

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:330

build

build(): void
Method to build the Notification

Memberof
Notification

Returns void
Implementation of INotification.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:340

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to update value when a parameters changed occurs

Memberof
OSFramework.Patterns.Notification.Notification
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of INotification.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:366

dispose

dispose(): void
Method to destroy the Notification

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Implementation of INotification.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:407

hide

hide(): void
Method to hide the notification, if it's visible.

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Implementation of INotification.hide
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:436

onSwipeBottom

onSwipeBottom(): void
Method to handle the platform swipe bottom gesture

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:448

onSwipeLeft

onSwipeLeft(): void
Method to handle the platform swipe left gesture

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:464

onSwipeRight

onSwipeRight(): void
Method to handle the platform swipe right gesture

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:479

onSwipeUp

onSwipeUp(): void
Method to handle the platform swipe top gesture

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:494

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method to register the provider callback

Memberof
OSFramework.Patterns.Notification.Notification
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of INotification.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:505

removeGestureEvents

removeGestureEvents(): void
Method to remove the gesture events to open/close the Notification on Mobile Apps

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Implementation of ISwipeEvent.removeGestureEvents
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:523

`Protected` setGestureEvents

setGestureEvents(onSwipeDownCallback: SwipeDown, onSwipeLeftCallback: SwipeLeft, onSwipeRightCallback: SwipeRight, onSwipeUpCallback: SwipeUp): void
Protected
Method to set the gesture events to open/close the Notification on Native Apps

Memberof
OSFramework.Patterns.Notification.Notification
Parameters
- onSwipeDownCallback: SwipeDown
- onSwipeLeftCallback: SwipeLeft
- onSwipeRightCallback: SwipeRight
- onSwipeUpCallback: SwipeUp
Returns void
Implementation of ISwipeEvent.setGestureEvents
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:539

show

show(): void
Method to show the notification, if it's closed.

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Implementation of INotification.show
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:559

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of INotification.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of INotification.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of INotification.uniqueId

Inherited from AbstractPattern.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of INotification.widgetId

Inherited from AbstractPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

gestureEventInstance

get gestureEventInstance(): SwipeEvent
Method to get Gesture Events Instance

Memberof
OSFramework.Patterns.Notification.Notification

Returns SwipeEvent
Implementation of ISwipeEvent.gestureEventInstance
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:572

hasGestureEvents

get hasGestureEvents(): boolean
Method to check if gesture events is applied

Memberof
OSFramework.Patterns.Notification.Notification

Returns boolean
Implementation of ISwipeEvent.hasGestureEvents
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:583

Constructors

constructor

new Notification(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.Notification.Notification
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Notification.Notification
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:33

Class Notification

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _autoCloseTimeoutId

Private _eventOnClick

Private _eventOnKeypress

Private _eventType

Private _focusManagerInstance

Private _focusTrapInstance

Private _gestureEventInstance

Private _hasGestureEvents

Private _isOpen

Private _parentSelf

Private _platformEventOnToggle

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _autoCloseNotification

Returns void

Private _clickCallback

Parameters

e: MouseEvent

Returns void

Private _handleFocusBehavior

Returns void

Private _handleGestureEvents

Returns void

Private _hideNotification

Returns void

Private _keypressCallback

Parameters

e: KeyboardEvent

Returns void

Private _removeEvents

Returns void

Private _showNotification

Returns void

Private _triggerOnToggleEvent

Parameters

isOpen: boolean

Returns void

Private _updateA11yProperties

Returns void

Private _updateCloseAfterTime

Parameters

value: number

Returns void

Private _updateInteractToClose

Parameters

value: boolean

Returns void

Private _updatePosition

`Protected` isProviderBased

`Private` _autoCloseTimeoutId

`Private` _eventOnClick

`Private` _eventOnKeypress

`Private` _eventType

`Private` _focusManagerInstance

`Private` _focusTrapInstance

`Private` _gestureEventInstance

`Private` _hasGestureEvents

`Private` _isOpen

`Private` _parentSelf

`Private` _platformEventOnToggle

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _autoCloseNotification

`Private` _clickCallback

`Private` _handleFocusBehavior

`Private` _handleGestureEvents

`Private` _hideNotification

`Private` _keypressCallback

`Private` _removeEvents

`Private` _showNotification

`Private` _triggerOnToggleEvent

`Private` _updateA11yProperties

`Private` _updateCloseAfterTime

`Private` _updateInteractToClose

`Private` _updatePosition

`Private` _updateWidth

`Protected` clearTimeouts

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` setInitialStates

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` setGestureEvents