SdkResponse Class

 

Applies To: Dynamics Marketing

Represents the abstract base class for all SDK response messages.

Namespace:   Microsoft.Dynamics.Marketing.SDK.Common
Assembly:  Microsoft.Dynamics.Marketing.SDK (in Microsoft.Dynamics.Marketing.SDK.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Dynamics.Marketing.SDK.Common.SdkMessage
    Microsoft.Dynamics.Marketing.SDK.Common.SdkResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Category.CreateOrUpdateCustomFieldCategoriesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Category.RetrieveCategoryValuesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.ActivateCompanyResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.CreateOrUpdateCompanyResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.DeleteCompanyResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.RetrieveCompaniesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.RetrieveCompanyResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.ActivateContactResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.CreateOrUpdateContactResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.CreateOrUpdateContactsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.CreateOrUpdateContactsWithResultsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.DeleteContactResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.PartialContactsUpdateResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.PartialContactUpdateResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveContactResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveContactsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveCurrenciesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveLanguagesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveSalutationsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.CustomField.RetrieveCustomFieldsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMarketingResult.RetrieveEmailMarketingResultsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveCommercialEmailMessagesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveContactPermissionsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveEmailMessageSentStatusResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveEmailMessagesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveMessageSchemaForEmailMessageResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveMissingContactPermissionsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveUnprocessedEmailHardBouncesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SendEmailMessageResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SetContactPermissionsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SetContactsPermissionsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SetEmailHardBouncesToProcessedForContactResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CancelEventAttendanceResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CancelEventRegistrationResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CreateOrUpdateEventAttendanceResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CreateOrUpdateEventRegistrationResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventAttendanceResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventAttendancesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventAttendanceStatusesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventRegistrationResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventRegistrationsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.CreateOrUpdateExternalEntityResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.DeleteExternalEntityResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.DeleteExternalEntityTypeResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.RetrieveExternalEntityResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.RetrieveExternalEntityTypesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.RetrieveExternalIdsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Landingpage.RetrieveSubmissionResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.CreateOrUpdateLeadResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.DeleteLeadResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadPrioritiesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadStatusesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveSalesRatingsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveTerritoriesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactsToMarketingListByEmailsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactsToMarketingListByIdsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactToMarketingListByEmailResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactToMarketingListByIdResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.CopyContactsFromMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.CopyQueryToMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.CreateMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.DeleteMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RemoveAllContactsFromMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RemoveContactFromMarketingListByEmailResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RemoveContactFromMarketingListByIdResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RetrieveAllListsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RetrieveMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RetrieveMarketingListsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.UpdateMarketingListResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.CreateOrUpdateMarketingResultResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.CreateOrUpdateMarketingResultsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.DeleteMarketingResultResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.PartialUpdateMarketingResultResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.PartialUpdateMarketingResultsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.RetrieveMarketingResultResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.RetrieveMarketingResultsResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.RetrieveMarketingResultTypesResponse
      Microsoft.Dynamics.Marketing.SDK.Messages.SdkErrorResponse

Syntax

[DataContractAttribute]
public abstract class SdkResponse : SdkMessage
[DataContractAttribute]
public ref class SdkResponse abstract : SdkMessage
[<AbstractClass>]
[<DataContractAttribute>]
type SdkResponse = 
    class
        inherit SdkMessage
    end
<DataContractAttribute>
Public MustInherit Class SdkResponse
    Inherits SdkMessage

Constructors

Name Description
System_CAPS_protmethod SdkResponse()

Initializes a new instance of the SdkResponse class.

Properties

Name Description
System_CAPS_pubproperty Message

Gets or sets the response message.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_static FromBrokeredMessage(BrokeredMessage)

Extracts the brokered message's body from the SDK response.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod ToBrokeredMessage()

Creates a new brokered message with the compressed and serialized SdkMessage.(Inherited from SdkMessage.)

System_CAPS_pubmethod ToBrokeredMessage(String)

Converts the SDK response message to a brokered message.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

These are messages that the third-party client reads from the SDK response queue that the customer has configured Microsoft Dynamics Marketing to send messages to.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

SdkRequest
SdkMessage
Microsoft.Dynamics.Marketing.SDK.Common Namespace
Sample: Manage lists and send transactional or commercial email
Sample: Work with marketing lists
Introduction to marketing entities

Return to top