Class Notification

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<NotificationConfig>
- Notification

Implements

Index

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/Pattern/AbstractPattern.ts:50

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/Pattern/AbstractPattern.ts:115

`Private` _autoCloseNotification

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

`Private` _clickCallback

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

`Private` _handleFocusTrap

_handleFocusTrap(): void
Returns void
- Defined in OSFramework/Pattern/Notification/Notification.ts:59

`Private` _handleGestureEvents

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

`Private` _hideNotification

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

`Private` _keypressCallback

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

`Private` _removeEvents

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

`Private` _showNotification

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

`Private` _triggerOnToggleEvent

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

`Private` _updateA11yProperties

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

`Private` _updateCloseAfterTime

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

`Private` _updateInteractToClose

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

`Private` _updatePosition

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

`Private` _updateWidth

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

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Sets the A11Y properties when the pattern is built.

Memberof
OSFramework.Patterns.Notification.Notification

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

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.Notification.Notification

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

`Protected` setHtmlElements

setHtmlElements(): void
Protected
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/Pattern/Notification/Notification.ts:263

`Protected` setInitialStates

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

Memberof
OSFramework.Patterns.Notification.Notification

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

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.Notification.Notification

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

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Notification.Notification

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

build

build(): void
Build object, instantiating dependencies, and manipulating DOM when necessary

Memberof
OSFramework.Interface.IBuilder

Returns void
Implementation of INotification.build

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

changeProperty

changeProperty(propertyName: string, propertyValue: any): void
Update value when a parameters changed occurs

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

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

dispose

dispose(): void
Destroy the Notification

Memberof
OSFramework.Patterns.Notification.Notification

Returns void
Implementation of INotification.dispose

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

hide

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

Memberof
OSFramework.Patterns.Notification.Notification

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

onSwipeBottom

onSwipeBottom(): void
Handle the platform swipe bottom gesture

Memberof
OSFramework.Patterns.Notification.Notification

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

onSwipeLeft

onSwipeLeft(): void
Handle the platform swipe left gesture

Memberof
OSFramework.Patterns.Notification.Notification

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

onSwipeRight

onSwipeRight(): void
Handle the platform swipe right gesture

Memberof
OSFramework.Patterns.Notification.Notification

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

onSwipeUp

onSwipeUp(): void
Handle the platform swipe top gesture

Memberof
OSFramework.Patterns.Notification.Notification

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

registerCallback

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

Memberof
OSFramework.Patterns.Notification.Notification
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of INotification.registerCallback
- Defined in OSFramework/Pattern/Notification/Notification.ts:488

removeGestureEvents

removeGestureEvents(): void
Removes 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/Pattern/Notification/Notification.ts:514

`Protected` setGestureEvents

setGestureEvents(onSwipeDownCallback: SwipeDown, onSwipeLeftCallback: SwipeLeft, onSwipeRightCallback: SwipeRight, onSwipeUpCallback: SwipeUp): void
Protected
Sets 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/Pattern/Notification/Notification.ts:530

show

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

Memberof
OSFramework.Patterns.Notification.Notification

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

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/Pattern/AbstractPattern.ts:128

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/Pattern/AbstractPattern.ts:139

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/Pattern/AbstractPattern.ts:150

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

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

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/Pattern/AbstractPattern.ts:172

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/Pattern/AbstractPattern.ts:183

gestureEventInstance

get gestureEventInstance(): SwipeEvent
Get Gesture Events Instance

Memberof
OSFramework.Patterns.Notification.Notification

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

hasGestureEvents

get hasGestureEvents(): boolean
Get if has gesture events

Memberof
OSFramework.Patterns.Notification.Notification

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

Properties

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnKeypress

_eventOnKeypress: Generic

`Private` _eventType

_eventType: string

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _focusableActiveElement

_focusableActiveElement: HTMLElement

`Private` _gestureEventInstance

_gestureEventInstance: SwipeEvent

`Private` _hasGestureEvents

_hasGestureEvents: boolean

`Private` _isOpen

_isOpen: boolean

`Private` _parentSelf

_parentSelf: HTMLElement

`Private` _platformEventOnInitialize

_platformEventOnInitialize: OSInitializedEvent

`Private` _platformEventOnToggle

_platformEventOnToggle: OSFramework.Patterns.Notification.Callbacks.OSOnToggleEvent

Constructors

constructor

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

Class Notification

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _autoCloseNotification

Returns void

Private _clickCallback

Parameters

e: MouseEvent

Returns void

Private _handleFocusTrap

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

Parameters

position: string

Returns void

Private _updateWidth

Parameters

width: string

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected setInitialStates

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

`Protected` finishBuild

`Private` _autoCloseNotification

`Private` _clickCallback

`Private` _handleFocusTrap

`Private` _handleGestureEvents

`Private` _hideNotification

`Private` _keypressCallback

`Private` _removeEvents

`Private` _showNotification

`Private` _triggerOnToggleEvent

`Private` _updateA11yProperties

`Private` _updateCloseAfterTime

`Private` _updateInteractToClose

`Private` _updatePosition

`Private` _updateWidth

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` setInitialStates

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` setGestureEvents

`Protected` _enableAccessibility