Skip to content

MessageWrapperLiteral

getAckType

@FMessageWrapperLiteral

Final ack type of the message, taking all overrides into account.

Return:

ModelTypeValue

getAckWhileActiveAllowed

@FMessageWrapperLiteral

Final ackWhileActiveAllowed flag of the message, taking all overrides into account.

Return:

BooleanLiteral

getClusterId

@FMessageWrapperLiteral

Final cluster of the message, taking all overrides into account.

Return:

IntegerLiteral

getComment

@FMessageWrapperLiteral

Return:

TextLiteral

getConstantName

@FMessageWrapperLiteral

On the platforms, a message is represented by a constant. This function returns the constant name which is used in the context of the controller.

Return:

StringLiteral

getConstantNameUnique

@FMessageWrapperLiteral

On the platforms, a message is represented by a constant. This function returns the constant name which is used in the context of the controller instance and is therefore unique.

Return:

StringLiteral

getControllerInstanceWrapper

@FMessageWrapperLiteral

Return:

ControllerInstanceWrapper

getDescriptions

@FMessageWrapperLiteral

Final description of the message, taking all overrides into account.

Return:

List<ATextSource>

getFullNameElements

@FMessageWrapperLiteral

List of all FullNameElements of a message

Return:

List<ATextSource>

getIndex

@FMessageWrapperLiteral

global message index

Return:

IntegerLiteral

getIndexLocal

@FMessageWrapperLiteral

Index within current controller

Return:

IntegerLiteral

getLevel

@FMessageWrapperLiteral

Return:

IntegerLiteral

getLog

@FMessageWrapperLiteral

Final log flag of the message, taking all overrides into account.

Return:

BooleanLiteral

getMessageDefinition

@FMessageWrapperLiteral

Return:

MessageDefinition

getPrio

@FMessageWrapperLiteral

Return:

IntegerLiteral

getPublish

@FMessageWrapperLiteral

Final publish flag of the message, taking all overrides into account.

Return:

BooleanLiteral

getReactionList

@FMessageWrapperLiteral

Returns all reactions as a list of AbstractMessageReaction.

Return:

List<AbstractMessageReaction>

getReactions

@FMessageWrapperLiteral

The bitwise sum of all reactions as integer.

Return:

LongLiteral

getType

@FMessageWrapperLiteral

Final type of the message, taking all overrides into account.

Return:

ModelTypeValue