Class Notification

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractPattern<NotificationConfig>
- Notification

Implements

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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

Returns SwipeEvent

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of ISwipeEvent.gestureEventInstance
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:574

hasGestureEvents

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

Returns boolean

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of ISwipeEvent.hasGestureEvents
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:585

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of INotification.equalsToID

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

`Protected`clearTimeouts

clearTimeouts(): void
Protected
Method to clear timeouts

Returns void

Memberof
Notification
- 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.

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
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.

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:285

`Protected`unsetCallbacks

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:316

`Protected`unsetHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:332

build

build(): void
Method to build the Notification

Returns void

Memberof
Notification
Implementation of INotification.build

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

changeProperty

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

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of INotification.changeProperty

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

dispose

dispose(): void
Method to destroy the Notification

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of INotification.dispose

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

hide

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of INotification.hide
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:438

onSwipeBottom

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:450

onSwipeLeft

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:466

onSwipeRight

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:481

onSwipeUp

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:496

registerCallback

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

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of INotification.registerCallback

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

removeGestureEvents

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of ISwipeEvent.removeGestureEvents
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:525

`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
Parameters
- onSwipeDownCallback: SwipeDown
- onSwipeLeftCallback: SwipeLeft
- onSwipeRightCallback: SwipeRight
- onSwipeUpCallback: SwipeUp
Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of ISwipeEvent.setGestureEvents
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:541

show

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

Returns void

Memberof
OSFramework.Patterns.Notification.Notification
Implementation of INotification.show
- Defined in OSFramework/OSUI/Pattern/Notification/Notification.ts:561

Class Notification

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Notification.Notification

Properties

ProtectedisProviderBased

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

gestureEventInstance

Returns SwipeEvent

Memberof

hasGestureEvents

Returns boolean

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

ProtectedclearTimeouts

Returns void

Memberof

ProtectedsetA11YProperties

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Memberof

ProtectedsetHtmlElements

Returns void

Memberof

ProtectedsetInitialStates

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

Memberof

ProtectedunsetHtmlElements

Returns void

Memberof

build

Returns void

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`clearTimeouts

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`setInitialStates

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`setGestureEvents