gem::PTAlert Class Reference

PTAlert object. More...

Inheritance diagram for gem::PTAlert:

Collaboration diagram for gem::PTAlert:

Public Member Functions
int	getCountUrlTranslations () const noexcept
	Get number of url translations in this alert.
int	getCountHeaderTextTranslations () const noexcept
	Get number of header text translations in this alert.
int	getCountDescriptionTextTranslations () const noexcept
	Get number of description text translations in this alert.
const PTTranslationRef	getUrlTranslation (int index) const noexcept
	Get url translation specified by index.
const PTTranslationRef	getHeaderTextTranslation (int index) const noexcept
	Get header text translation specified by index.
const PTTranslationRef	getDescriptionTextTranslation (int index) const noexcept
	Get description text translation specified by index.

Detailed Description

PTAlert object.

Implements share-read / copy-on-write Api object over IPTAlert.

Member Function Documentation

getCountDescriptionTextTranslations()

int gem::PTAlert::getCountDescriptionTextTranslations ( ) const

inlinenoexcept

Get number of description text translations in this alert.

Returns

Number of description text translations.

getCountHeaderTextTranslations()

int gem::PTAlert::getCountHeaderTextTranslations ( ) const

inlinenoexcept

Get number of header text translations in this alert.

Returns

Number of header text translations.

getCountUrlTranslations()

int gem::PTAlert::getCountUrlTranslations ( ) const

inlinenoexcept

Get number of url translations in this alert.

Returns

Number of url translations.

getDescriptionTextTranslation()

const PTTranslationRef gem::PTAlert::getDescriptionTextTranslation ( int index ) const

inlinenoexcept

Get description text translation specified by index.

Parameters

[in]

index

Index of the description text translation.

Returns

empty Index is out of bounds.

getHeaderTextTranslation()

const PTTranslationRef gem::PTAlert::getHeaderTextTranslation ( int index ) const

inlinenoexcept

Get header text translation specified by index.

Parameters

[in]

index

Index of the header text translation.

Returns

empty Index is out of bounds.

getUrlTranslation()

const PTTranslationRef gem::PTAlert::getUrlTranslation ( int index ) const

inlinenoexcept

Get url translation specified by index.

Parameters

[in]

index

Index of the url translation.

Returns

empty if Index is out of bounds.