Namespace: Consultingwerk.Framework.MessageInteraction
Class 
MessageInteractionService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.MessageInteraction.MessageInteractionService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.MessageInteraction.IMessageInteractionService

Purpose: Adds a question to be answered to the list of questions or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, character, MessageButtons, MessageReplyEnum) Adds a question to be answered to the list of questions or returns an already given reply
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum) Adds a question to be answered to the list of questions or returns an already given reply
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, MessageButtons, MessageReplyEnum) Adds a question to be answered to the list of questions or returns an already given reply
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum) Adds a question to be answered to the list of questions or returns an already given reply
+ CHARACTER MessageId () Returns a unique message id
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowInputPrompt (ListInputPrompt, character, character, character, JsonSerializable, InputPromptProperty[]) Adds an InputPrompt to be answered to the list of InputPrompts or returns an already given reply
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowInputPrompt (ListInputPrompt, character, character, JsonSerializable, InputPromptProperty[]) Adds an InputPrompt to be answered to the list of InputPrompts or returns an already given reply


Method Detail
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, character, MessageButtons, MessageReplyEnum)
Purpose: Adds a question to be answered to the list of questions or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The List of Questions to add the question to (mandatory)
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The message detail to show to the users
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The combination of message buttons
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The default message button
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum)
Purpose: Adds a question to be answered to the list of questions or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The List of Questions to add the question to (mandatory)
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The message detail to show to the users
poMessageType Consultingwerk.SmartFramework.MessageTypeEnum
The MessageTypeEnum value
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The combination of message buttons
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The default message button
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, MessageButtons, MessageReplyEnum)
Purpose: Adds a question to be answered to the list of questions or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The List of Questions to add the question to (mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The message detail to show to the users
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The combination of message buttons
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The default message button
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (ListQuestion, character, character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum)
Purpose: Adds a question to be answered to the list of questions or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The List of Questions to add the question to (mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The message detail to show to the users
poMessageType Consultingwerk.SmartFramework.MessageTypeEnum
The MessageTypeEnum value
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The combination of message buttons
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The default message button
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question
Top

PUBLIC CHARACTER MessageId ()
Purpose: Returns a unique message id
Notes: The message id is used to identify the message in the source code

Returns CHARACTER
A unique message id
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowInputPrompt (ListInputPrompt, character, character, character, JsonSerializable, InputPromptProperty[])
Purpose: Adds an InputPrompt to be answered to the list of InputPrompts or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
poInputPrompts Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The List of InputPrompts to add the InputPrompt to (mandatory)
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcTitle CHARACTER
The text for the message
poValueObject Consultingwerk.JsonSerializable
The value object instance
poProperties Consultingwerk.Framework.MessageInteraction.InputPromptProperty
The Properties
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowInputPrompt (ListInputPrompt, character, character, JsonSerializable, InputPromptProperty[])
Purpose: Adds an InputPrompt to be answered to the list of InputPrompts or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
poInputPrompts Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The List of InputPrompts to add the InputPrompt to (mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcTitle CHARACTER
The text for the message
poValueObject Consultingwerk.JsonSerializable
The value object instance
poProperties Consultingwerk.Framework.MessageInteraction.InputPromptProperty
The Properties
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question


©2006-2025 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       31.05.2025 16:58:31