SetStateRequest Class
TOC
Collapse the table of content
Expand the table of content

SetStateRequest Class

 

Contains the data that’s needed to set the state of an entity record.

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

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

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SetStateRequest : OrganizationRequest

NameDescription
System_CAPS_pubmethodSetStateRequest()

Initializes a new instance of the SetStateRequest class.

NameDescription
System_CAPS_pubpropertyEntityMoniker

Gets or sets the entity. Required.

System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

System_CAPS_pubpropertyState

Gets or sets the state of the entity record. Required.

System_CAPS_pubpropertyStatus

Gets or sets the status that corresponds to the State property. Required.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_importantImportant

This message request is deprecated. Consider using the UpdateRequest instead. For more information see Perform specialized operations using Update.

Message Availability

This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the EntityMoniker property.

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

Valid State and Status value combinations

The valid combinations of state and status code values varies for many entities. For a list of default values for specific system entities, see Default status and status reason values.

For a list of the state and status values valid for custom entities in your organization, refer to the entity metadata.

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

Supported Entities

The following table shows the default entities that support this message and whether the message is available when the caller is connected to the server (Server), disconnected from the server (Offline) or both (Both).

Entity

Availability

Account

2 (Both)

Appointment

2 (Both)

BusinessUnit

2 (Both)

Campaign

2 (Both)

CampaignActivity

2 (Both)

CampaignResponse

2 (Both)

Connection

2 (Both)

ConnectionRole

2 (Both)

Contact

2 (Both)

Contract

2 (Both)

ContractDetail

2 (Both)

ConvertRule

2 (Both)

DiscountType

2 (Both)

DynamicProperty

2 (Both)

Email

2 (Both)

EmailServerProfile

2 (Both)

Entitlement

2 (Both)

Fax

2 (Both)

Goal

2 (Both)

GoalRollupQuery

2 (Both)

ImportMap

2 (Both)

Incident

2 (Both)

IncidentResolution

2 (Both)

Invoice

2 (Both)

KbArticle

2 (Both)

Lead

2 (Both)

Letter

2 (Both)

List

2 (Both)

Mailbox

2 (Both)

MailMergeTemplate

2 (Both)

Metric

2 (Both)

msdyn_PostAlbum

2 (Both)

msdyn_PostConfig

2 (Both)

msdyn_PostRuleConfig

2 (Both)

msdyn_wallsavedquery

2 (Both)

msdyn_wallsavedqueryusersettings

2 (Both)

Opportunity

2 (Both)

OpportunityClose

2 (Both)

OrderClose

2 (Both)

PhoneCall

2 (Both)

Position

2 (Both)

PriceLevel

2 (Both)

ProcessSession

2 (Both)

Product

2 (Both)

ProductAssociation

2 (Both)

Queue

2 (Both)

QueueItem

2 (Both)

Quote

2 (Both)

QuoteClose

2 (Both)

RecurringAppointmentMaster

2 (Both)

RelationshipRole

2 (Both)

RoutingRule

2 (Both)

SalesOrder

2 (Both)

SavedQuery

2 (Both)

SdkMessageProcessingStep

2 (Both)

ServiceAppointment

2 (Both)

SharePointDocumentLocation

2 (Both)

SharePointSite

2 (Both)

SLA

2 (Both)

SocialActivity

2 (Both)

SocialProfile

2 (Both)

SystemUser

2 (Both)

Task

2 (Both)

TransactionCurrency

2 (Both)

UoMSchedule

2 (Both)

UserQuery

2 (Both)

Workflow

2 (Both)

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.



// Create the Request Object
SetStateRequest state = new SetStateRequest();

// Set the Request Object's Properties
state.State = new OptionSetValue((int)IncidentState.Active);
state.Status = 
    new OptionSetValue((int)incident_statuscode.WaitingforDetails);

// Point the Request to the case whose state is being changed
state.EntityMoniker = caseReference;

// Execute the Request
SetStateResponse stateSet = (SetStateResponse)_serviceProxy.Execute(state);

// Check if the state was successfully set
Incident incident = _serviceProxy.Retrieve(Incident.EntityLogicalName, 
    _caseIncidentId, new ColumnSet(allColumns: true)).ToEntity<Incident>();

if (incident.StatusCode.Value == (int)incident_statuscode.WaitingforDetails)
{
    Console.WriteLine("Record state set successfully.");
}
else
{
    Console.WriteLine("The request to set the record state failed.");
}

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

Return to top

Microsoft Dynamics CRM 2016 and CRM Online

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show:
© 2016 Microsoft