Class InAppMessageAbstract

Hierarchy (view full)

Constructors

constructor

Properties

animateIn? animateOut? backgroundColor? buttons? clickAction? closeButtonColor? cropType? css? dismissType? duration? extras? frameColor? header? headerAlignment? headerTextColor? htmlId? icon? iconBackgroundColor? iconColor? imageStyle? imageUrl? isControl message? messageAlignment? messageExtras? openTarget? orientation? slideFrom? textColor? triggerId? uri?

Methods

closeMessage removeAllSubscriptions removeSubscription subscribeToClickedEvent subscribeToDismissedEvent

Constructors

constructor

  • new InAppMessage(props?): InAppMessage

  • Parameters

    • Optional props: InAppMessageProps

    Returns InAppMessage

Properties

Optional animateIn

animateIn?: boolean

Optional animateOut

animateOut?: boolean

Optional backgroundColor

backgroundColor?: number

Optional buttons

buttons?: InAppMessageButton[]

Optional clickAction

clickAction?: ClickActionOptions

Optional closeButtonColor

closeButtonColor?: number

Optional cropType

cropType?: CropTypeOptions

Optional css

css?: string

Optional dismissType

dismissType?: DismissTypeOptions

Optional duration

duration?: number

Optional extras

extras?: Record<string, string>

Optional frameColor

frameColor?: number

Optional header

header?: string

Optional headerAlignment

headerAlignment?: string

Optional headerTextColor

headerTextColor?: number

Optional htmlId

htmlId?: string

Optional icon

icon?: string

Optional iconBackgroundColor

iconBackgroundColor?: number

Optional iconColor

iconColor?: number

Optional imageStyle

imageStyle?: ImageStyleOptions

Optional imageUrl

imageUrl?: string

isControl

isControl: boolean

Optional message

message?: string

Optional messageAlignment

messageAlignment?: TextAlignmentOptions

Optional messageExtras

messageExtras?: Record<string, string> | None

Optional openTarget

openTarget?: OpenTargetOptions

Optional orientation

orientation?: OrientationOptions

Optional slideFrom

slideFrom?: SlideFromOptions

Optional textColor

textColor?: number

Optional triggerId

triggerId?: string

Optional uri

uri?: string

Methods

closeMessage

  • closeMessage(): void

  • Returns void

removeAllSubscriptions

  • removeAllSubscriptions(): void

  • Returns void

removeSubscription

  • removeSubscription(subscriptionGuid): void

  • Parameters

    • subscriptionGuid: string

    Returns void

subscribeToClickedEvent

  • subscribeToClickedEvent(subscriber): null | string

  • BEGIN PUBLIC METHODS *

    Parameters

    • subscriber: (() => void)
        • (): void

        • Returns void

    Returns null | string

subscribeToDismissedEvent

  • subscribeToDismissedEvent(subscriber): null | string

  • Parameters

    • subscriber: (() => void)
        • (): void

        • Returns void

    Returns null | string