| CorrigoService Class |
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Web.Services.ProtocolsWebClientProtocol
System.Web.Services.ProtocolsHttpWebClientProtocol
System.Web.Services.ProtocolsSoapHttpClientProtocol
CorrigoServiceCorrigoService
SystemMarshalByRefObject
System.ComponentModelComponent
System.Web.Services.ProtocolsWebClientProtocol
System.Web.Services.ProtocolsHttpWebClientProtocol
System.Web.Services.ProtocolsSoapHttpClientProtocol
CorrigoServiceCorrigoService
Namespace: CorrigoService
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class CorrigoService : SoapHttpClientProtocol
The CorrigoService type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CancelAsync | |
| Execute |
Executes a message that either represents a specialized method or specific business logic.
It takes an instance of a CommandRequest base class message as input parameter and returns an instance of a CommandResponse base class message.
You must cast the return value of the Execute method to the specific instance of the response command that corresponds to the request parameter.
|
| ExecuteAsync(CommandRequest) | |
| ExecuteAsync(CommandRequest, Object) | |
| ExecuteMultiple |
Executes a list of messages that either represents a specialized method or specific business logic.
It takes a list of instances of a CommandRequest base class message as an input parameter and returns a list of instances of a CommandResponse base class message.
You must cast every CommandResponse instance returned by the ExecuteMultiple method to the specific instance of the response command that corresponds to the appropriate request parameter.
|
| ExecuteMultipleAsync(CommandRequest) | |
| ExecuteMultipleAsync(CommandRequest, Object) | |
| GetCompanyWsdkUrl |
Converts a Company Name argument into a fully-qualified URL for WSDK calls.
|
| GetCompanyWsdkUrlAsync(String, Protocols) | |
| GetCompanyWsdkUrlAsync(String, Protocols, Object) | |
| LogInCompany |
Login into HOST-INDEPENDENT WSDL with Company Name, i.e. http://www.corrigonet.corrigo.com/...
|
| LogInCompanyAsync(String, String, String) | |
| LogInCompanyAsync(String, String, String, Object) | |
| LogInStatus |
Get current Login status for the session.
|
| LogInStatusAsync | |
| LogInStatusAsync(Object) | |
| LogOut |
Log Out of the session.
|
| LogOutAsync | |
| LogOutAsync(Object) | |
| Retrieve |
Retrieves an instance of an entity. Takes two parameters:
first of them specifies an entity by identifier and entity type (instance of EntitySpecifier class should be passed);
second parameter specifies the set of properties to retrieve (to retrieve all properties, pass a new instance of the AllProperties class).
Returns an instance of the CorrigoEntity requested or null if no entity was found.
The CorrigoEntity class contains only the properties specified by the input parameter.
Use this method to retrieve an instance of the CorrigoNet entity.
Your client application must be logged in with sufficient access rights to retrieve a specified object and to retrieve the properties in the specified property list.
|
| RetrieveAsync(EntitySpecifier, PropertySetBase) | |
| RetrieveAsync(EntitySpecifier, PropertySetBase, Object) | |
| RetrieveMultiple |
Uses a query expression to retrieve CorrigoNet entities.
Takes single parameter which specifies either a QueryExpression or a QueryByProperty object derived from the QueryBase class.
This is the query to be executed for an entity.
Returns a collection of entities of the type specified in the query parameter.
If the query specified returned no results, an empty collection is returned.
Use this method to retrieve one or more entity instances based on criteria specified in the input parameter.
|
| RetrieveMultipleAsync(QueryBase) | |
| RetrieveMultipleAsync(QueryBase, Object) |
Properties| Name | Description | |
|---|---|---|
 | CorrigoNetOptionsValue |
Holds the Corrigo Enterprise options SOAP header.
|
| Url | |
| UseDefaultCredentials |
Events| Name | Description | |
|---|---|---|
 | ExecuteCompleted | |
| ExecuteMultipleCompleted | |
| GetCompanyWsdkUrlCompleted | |
| LogInCompanyCompleted | |
| LogInStatusCompleted | |
| LogOutCompleted | |
| RetrieveCompleted | |
| RetrieveMultipleCompleted |
RemarksSee Also