Namespace: Consultingwerk.CommonUi.Messages
Interface 
IMessageService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.Framework.MessageInteraction.IMessageServiceWithInteraction
Implemented by: Consultingwerk.Framework.MessageInteraction.MessageServiceWithInteraction, Consultingwerk.Util.MessageFormService

File:IMessageInteractionService
Purpose:Abstracts presentation of messages
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Sep 23 10:38:43 CEST 2021
Purpose: Asks a question to the user
Notes: The pcMessageId parameter is mandatory
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



Top Method Summary
Options Name Purpose
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (character, character, character, character) Asks a question to the user
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (character, character, character, character, character) Asks a question to the user
+ ShowMessage (character, character, character) Shows a Message to the User
+ ShowMessage (character, character, character, character) Shows a Message to the User
+ ShowMessage (character, character, character, character, character) Shows a Message to the User
+ ShowMessage (character, character, character, CommonMessageTypeEnum, character, character) Shows a Message to the User
+ ShowMessage (character, character, CommonMessageTypeEnum, character, character) Shows a Message to the User
+ ShowMessage (character, CommonMessageTypeEnum, character, character) Shows a Message to the User


Method Detail
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (character, character, character, character)

Purpose: Asks a question to the user
Notes: The pcMessageId parameter is mandatory
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:
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
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)
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 (character, character, character, character, character)

Purpose: Asks a question to the user
Notes: The pcMessageId parameter is mandatory
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:
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The message detail to show to the users
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)
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 ShowMessage (character, character, character)

Purpose: Shows a Message to the User
Notes:

Parameters:
pcMessageText CHARACTER
The message to show
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)
Top

PUBLIC ShowMessage (character, character, character, character)

Purpose: Shows a Message to the User
Notes:

Parameters:
pcMessageText CHARACTER
The message to show
pcMessageTitle CHARACTER
The title for the message
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)
Top

PUBLIC ShowMessage (character, character, character, character, character)

Purpose: Shows a Message to the User
Notes:

Parameters:
pcMessageText CHARACTER
The message to show
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The detail text for the message
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)
Top

PUBLIC ShowMessage (character, character, character, CommonMessageTypeEnum, character, character)

Purpose: Shows a Message to the User
Notes:

Parameters:
pcMessageText CHARACTER
The message to show
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The detail text for the message
poMessageType Consultingwerk.CommonUi.Messages.CommonMessageTypeEnum
The CommonMessageTypeNum indicating the type of message
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)
Top

PUBLIC ShowMessage (character, character, CommonMessageTypeEnum, character, character)

Purpose: Shows a Message to the User
Notes:

Parameters:
pcMessageText CHARACTER
The message to show
pcMessageTitle CHARACTER
The title for the message
poMessageType Consultingwerk.CommonUi.Messages.CommonMessageTypeEnum
The CommonMessageTypeNum indicating the type of message
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)
Top

PUBLIC ShowMessage (character, CommonMessageTypeEnum, character, character)

Purpose: Shows a Message to the User
Notes:

Parameters:
pcMessageText CHARACTER
The message to show
poMessageType Consultingwerk.CommonUi.Messages.CommonMessageTypeEnum
The CommonMessageTypeNum indicating the type of message
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)


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.03.2024 00:27:04