KVSKBA IDispatchProvider
Procedures
Id() : Guid
Summary: Gets the unique identifier for the implementation.
procedure Id(): Guid
Returns: The unique identifier (GUID) for the implementation.
Remarks: This procedure should return a consistent GUID that uniquely identifies the implementation of the IDispatchProvider interface. This allows the system to recognize and differentiate between multiple implementations of the interface.
Version() : Text
Summary: Gets the version of the implementation.
procedure Version(): Text
Returns: The version of the implementation.
Remarks: This procedure should return a string representing the version of the implementation. This can be used for testing, debugging, or informational purposes to track which version of the implementation is being used.
Name() : Text
Summary: Gets the display name of the implementation for user interaction.
procedure Name(): Text
Returns: The display name of the implementation.
Remarks: This procedure should return a user-friendly name for the implementation that can be displayed in the user interface. This name should be descriptive enough to help users understand the purpose of the implementation when they see it in a list or selection menu.
Description() : Text
Summary: Gets a description of the implementation, including details about supported providers or other relevant information.
procedure Description(): Text
Returns: A description of the implementation.
Remarks: This procedure should return a detailed description of the implementation, which may include information about the providers it supports, its capabilities, or any other relevant details that can help users or developers understand what the implementation does and how it can be used.
Send(Variant, Text) : Boolean
Summary: Transforms and forwards the given document to a specific multi-carrier dispatch solution.
procedure Send(rec: Variant; var response: Text): Boolean
Parameters:
rec: The document to be sent.response: The response from the dispatch solution.
Returns: True if the document was successfully sent; otherwise, false.
Status(Variant, Text) : Boolean
Summary: Requests the status for a given document from a specific multi-carrier dispatch solution.
procedure Status(rec: Variant; var response: Text): Boolean
Parameters:
rec: The document for which to request the status.response: The response from the dispatch solution.
Returns: True if the status was successfully retrieved; otherwise, false.