View Source

Class RefreshInstruction

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Sync

Assembly: Umbraco.Core.dll

Syntax

public class RefreshInstruction

Constructors

RefreshInstruction()

Initializes a new instance of the class.

Declaration

public RefreshInstruction()

Remarks

Need this public, parameter-less constructor so the web service messenger can de-serialize the instructions it receives.

RefreshInstruction(Guid, RefreshMethodType, Guid, Int32, String, String)

Initializes a new instance of the class.

Declaration

public RefreshInstruction(Guid refresherId, RefreshMethodType refreshType, Guid guidId, int intId, string jsonIds, string jsonPayload)

Parameters

Type	Name	Description
Guid	refresherId
RefreshMethodType	refreshType
Guid	guidId
System.Int32	intId
System.String	jsonIds
System.String	jsonPayload

Remarks

Need this public one so it can be de-serialized - used by the Json thing otherwise, should use GetInstructions(...)

Properties

GuidId

Gets or sets the Guid data value.

Declaration

public Guid GuidId { get; set; }

Property Value

Type	Description
Guid

IntId

Gets or sets the int data value.

Declaration

public int IntId { get; set; }

Property Value

Type	Description
System.Int32

JsonIdCount

Gets or sets the number of Ids contained in the JsonIds json value.

Declaration

public int JsonIdCount { get; set; }

Property Value

Type	Description
System.Int32

Remarks

This is used to determine the instruction count per row.

JsonIds

Gets or sets the ids data value.

Declaration

public string JsonIds { get; set; }

Property Value

Type	Description
System.String

JsonPayload

Gets or sets the payload data value.

Declaration

public string JsonPayload { get; set; }

Property Value

Type	Description
System.String

RefresherId

Gets or sets the refresher unique identifier.

Declaration

public Guid RefresherId { get; set; }

Property Value

Type	Description
Guid

RefreshType

Gets or sets the refresh action type.

Declaration

public RefreshMethodType RefreshType { get; set; }

Property Value

Type	Description
RefreshMethodType

Methods

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

Equals(RefreshInstruction)

Declaration

protected bool Equals(RefreshInstruction other)

Parameters

Type	Name	Description
RefreshInstruction	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

GetInstructions(ICacheRefresher, IJsonSerializer, MessageType, Nullable<IEnumerable<Object>>, Nullable<Type>, String)

Declaration

public static IEnumerable<RefreshInstruction> GetInstructions(ICacheRefresher refresher, IJsonSerializer jsonSerializer, MessageType messageType, IEnumerable<object>? ids, Type? idType, string json)

Parameters

Type	Name	Description
ICacheRefresher	refresher
IJsonSerializer	jsonSerializer
MessageType	messageType
System.Nullable<IEnumerable<System.Object>>	ids
System.Nullable<Type>	idType
System.String	json

Returns

Type	Description
IEnumerable<RefreshInstruction>

Operators

Equality(RefreshInstruction, RefreshInstruction)

Declaration

public static bool operator ==(RefreshInstruction left, RefreshInstruction right)

Parameters

Type	Name	Description
RefreshInstruction	left
RefreshInstruction	right

Returns

Type	Description
System.Boolean

Inequality(RefreshInstruction, RefreshInstruction)

Declaration

public static bool operator !=(RefreshInstruction left, RefreshInstruction right)

Parameters

Type	Name	Description
RefreshInstruction	left
RefreshInstruction	right

Returns

Type	Description
System.Boolean