This topic has not yet been rated - Rate this topic

Callout Method Signatures

CRM 1.2

When implementing your callout class, derive your custom class from the CrmCalloutBase class. The callout component methods are defined using the 'virtual' keyword and have fixed signatures. Override the callout methods in your derived class. For a description of what each component method does, see the Callout Model section.

Method Signatures for Pre-Callouts

This section lists the component method signatures for pre-events. For a complete method reference and information about the user context and entity context, see the Reference section.

PreAssign

public override PreCalloutReturnValue PreAssign(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  Guid  assignedToId,
  ref string  errorMessage
);

PreCreate

public override PreCalloutReturnValue PreCreate(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  ref string  entityXml,
  ref string  errorMessage
);

PreDelete

public override PreCalloutReturnValue PreDelete(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  ref string  errorMessage
);

PreMerge

public override PreCalloutReturnValue PreMerge(
  CalloutUserContext  userContext,
  CalloutEntityContext  masterEntityContext,
  CalloutEntityContext  subordinateEntityContext,
  ref string  mergeUpdateEntityXml,
  ref string  errorMessage
);

PreSend

public override PreCalloutReturnValue PreSend(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  ref string  errorMessage
);

PreSetState

public override PreCalloutReturnValue PreSetState(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  ref int  newStateCode,
  ref int  newStatusCode,
  ref string  errorMessage
);

PreUpdate

public override PreCalloutReturnValue PreUpdate(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  ref string  entityXml,
  ref string  errorMessage
);

Entity information is passed to the pre-callout method in the entityXml parameter. The method can then modify the entity XML data through that same parameter. The PreCalloutReturnValue can be set to continue, stop, or abort as described in the Callout Return Codes reference.

Method Signatures for Post-Callouts

This section lists the component method signatures for synchronous post-events. You can find information about the user context, entity context, and post entity XML schema in the Reference section.

The XML string passed to the callouts is a serialized DynamicEntity. For more information, see Using DynamicEntity to Access Entities at Runtime.

PostAssign

public override void PostAssign(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  preImageEntityXml,
  string  postImageEntityXml
);

PostCreate

public override void PostCreate(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  postImageEntityXml
);

PostDelete

public override void PostDelete(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  preImageEntityXml
);

PostDeliver

public override void PostDeliver(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  postImageEntityXml
);

PostMerge

public override void PostMerge(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  preImageMasterEntityXml,
  string  preImageSubordinateEntityXml,
  string  postImageMasterEntityXml
);

PostSetState

public override void PostSetState(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  preImageEntityXml,
  string  postImageEntityXml
);

PostUpdate

public override void PostUpdate(
  CalloutUserContext  userContext,
  CalloutEntityContext  entityContext,
  string  preImageEntityXml,
  string  postImageEntityXml
);

Related Topics

Callout Reference

Callout Sample

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)