InstallSampleDataRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to install the sample data.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.InstallSampleDataRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class InstallSampleDataRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class InstallSampleDataRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type InstallSampleDataRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class InstallSampleDataRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod InstallSampleDataRequest()

Initializes a new instance of the InstallSampleDataRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of InstallSampleDataResponse.

Privileges and Access Rights

For a complete list of the privileges required, see InstallSampleData message privileges.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.



    // Prompt user to install/uninstall sample data.
    Console.WriteLine("Would you like to:");
    Console.WriteLine("1) Install sample data for Microsoft Dynamics CRM?");
    Console.WriteLine("2) Uninstall sample data for Microsoft Dynamics CRM?");
    Console.Write("Press [1] to Install, [2] to Uninstall: ");
    String answer = Console.ReadLine();

    // Update the sample data based on the user's response.
    switch (answer)
    {
        case "1":
            Console.WriteLine("Installing sample data...");
            InstallSampleDataRequest request =
                new InstallSampleDataRequest();
            InstallSampleDataResponse response =
                (InstallSampleDataResponse)_serviceProxy.Execute(request);
            Console.WriteLine("Sample data successfully installed.");
            break;
        case "2":
            Console.WriteLine("Uninstalling sample data...");
            UninstallSampleDataRequest request2 =
                new UninstallSampleDataRequest();
            UninstallSampleDataResponse response2 =
                (UninstallSampleDataResponse)_serviceProxy.Execute(request2);
            Console.WriteLine("Sample data successfully uninstalled.");
            break;
        default:
            Console.WriteLine("Neither option was selected. No changes have been made to your records.");
            break;
    }

}


    ' Prompt user to install/uninstall sample data.
    Console.WriteLine("Would you like to:")
    Console.WriteLine("1) Install sample data for Microsoft Dynamics CRM?")
    Console.WriteLine("2) Uninstall sample data for Microsoft Dynamics CRM?")
    Console.Write("Press [1] to Install, [2] to Uninstall: ")
    Dim answer As String = Console.ReadLine()

    ' Update the sample data based on the user's response.
    Select Case answer
        Case "1"
            Console.WriteLine("Installing sample data...")
            Dim request As New InstallSampleDataRequest()
            Dim response As InstallSampleDataResponse = CType(_serviceProxy.Execute(request), InstallSampleDataResponse)
            Console.WriteLine("Sample data successfully installed.")
        Case "2"
            Console.WriteLine("Uninstalling sample data...")
            Dim request2 As New UninstallSampleDataRequest()
            Dim response2 As UninstallSampleDataResponse = CType(_serviceProxy.Execute(request2), UninstallSampleDataResponse)
            Console.WriteLine("Sample data successfully uninstalled.")
        Case Else
            Console.WriteLine("Neither option was selected. No changes have been made to your records.")
    End Select

End Using

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

T:Microsoft.Crm.Sdk.Messages.UnInstallSampleDataResponse
T:Microsoft.Crm.Sdk.Messages.UnInstallSampleDataRequest
Microsoft.Crm.Sdk.Messages Namespace
Sample data for Microsoft Dynamics CRM
Sample: Install or remove sample data

Return to top

© 2016 Microsoft. All rights reserved. Copyright