View Source

Class RefreshInstruction

Inheritance

object

Namespace: Umbraco.Cms.Core.Sync

Assembly: Umbraco.Core.dll

Syntax

[Serializable]
[DataContract]
public class RefreshInstruction

Constructors

RefreshInstruction()

Initializes a new instance of the RefreshInstruction 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, int, string, string)

Initializes a new instance of the RefreshInstruction 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
int	intId
string	jsonIds
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

[DataMember]
public Guid GuidId { get; set; }

Property Value

Type	Description
Guid

IntId

Gets or sets the int data value.

Declaration

[DataMember]
public int IntId { get; set; }

Property Value

Type	Description
int

JsonIdCount

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

Declaration

public int JsonIdCount { get; set; }

Property Value

Type	Description
int

Remarks

This is used to determine the instruction count per row.

JsonIds

Gets or sets the ids data value.

Declaration

[DataMember]
public string? JsonIds { get; set; }

Property Value

Type	Description
string

JsonPayload

Gets or sets the payload data value.

Declaration

[DataMember]
public string? JsonPayload { get; set; }

Property Value

Type	Description
string

RefreshType

Gets or sets the refresh action type.

Declaration

[DataMember]
public RefreshMethodType RefreshType { get; set; }

Property Value

Type	Description
RefreshMethodType

RefresherId

Gets or sets the refresher unique identifier.

Declaration

[DataMember]
public Guid RefresherId { get; set; }

Property Value

Type	Description
Guid

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object? other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(RefreshInstruction)

Declaration

protected bool Equals(RefreshInstruction other)

Parameters

Type	Name	Description
RefreshInstruction	other

Returns

Type	Description
bool

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

GetInstructions(ICacheRefresher, IJsonSerializer, MessageType, IEnumerable<object>?, 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
IEnumerable<object>	ids
Type	idType
string	json

Returns

Type	Description
IEnumerable<RefreshInstruction>

Operators

operator ==(RefreshInstruction, RefreshInstruction)

Declaration

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

Parameters

Type	Name	Description
RefreshInstruction	left
RefreshInstruction	right

Returns

Type	Description
bool

operator !=(RefreshInstruction, RefreshInstruction)

Declaration

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

Parameters

Type	Name	Description
RefreshInstruction	left
RefreshInstruction	right

Returns

Type	Description
bool