Class EntityLoadResult

Namespace

The.Web.Entities

Assembly

Instagile.Web.Client.dll

The outcome of LoadEntityCachedAsync(IEntityInfo, IEntityContext, Guid, RequestOptions?): the loaded entity, the cache state it arrived in, and - for cached results - its update stream.

public sealed class EntityLoadResult

Inheritance

object

EntityLoadResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Entity

The loaded entity, reified into the load context.

public IEntity Entity { get; }

Property Value

IEntity

State

Describes the source of the entity and whether updates are likely to be raised.

public ResultState State { get; }

Property Value

ResultState

Methods

AddUpdateHandler(UpdateHandler<IEntity>, bool)

Create a weak event subscription, raised when a new value is available for the loaded entity. Returns a liveness token that must stay referenced for as long as updates matter; null when the result is uncached (no updates will occur).

public object? AddUpdateHandler(UpdateHandler<IEntity> handler, bool once = false)

Parameters

handler UpdateHandler<IEntity>

once bool

Returns

object