Namespace: Consultingwerk.Framework.MessageInteraction
Interface 
IMessageInteractionService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.Framework.MessageInteraction.MessageInteractionService

File:IMessageInteractionService
Purpose:Service Interface for services that provide message interaction
between business logic and consumer
Description:The IMessageInteractionService is used from the business
logic to register messages (questions) that should be
answered from the consumer (user) and provides access
to already given answers using the same method call
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Sep 01 09:04:00 CEST 2015
Notes:SCL-996
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


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 message type
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


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:51:40