Show / Hide Table of Contents

    Class LiquidTransformComponent

    Implements a message pipeline component that transforms the message content using Liquid Template Language (https://shopify.github.io/liquid/).

    Inheritance
    Object
    MessagePipelineComponentBase
    TransformationComponentBase
    LiquidTransformComponent
    Implements
    IValidator
    IEquatable<MessagePipelineComponentBase>
    IExtensibleDataObject
    Inherited Members
    TransformationComponentBase.GetSourceValue(MessagePipelineContext, Boolean)
    TransformationComponentBase.SetSourceValue(MessagePipelineContext, String)
    TransformationComponentBase.SetSourceValue(MessagePipelineContext, XmlReader)
    TransformationComponentBase.SourceType
    TransformationComponentBase.SourceName
    MessagePipelineComponentBase.Validate(MessagePipelinePositions)
    MessagePipelineComponentBase.AllowedPositions
    MessagePipelineComponentBase.ErrorMessage
    MessagePipelineComponentBase.ExtensionData
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Nevatech.Vsb.Repository.Processing
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    public sealed class LiquidTransformComponent : TransformationComponentBase, IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

    Constructors

    LiquidTransformComponent()

    Declaration
    public LiquidTransformComponent()

    Fields

    ElementName

    Name of the root element when object is serialized to XML.

    Declaration
    public const string ElementName = "TRANSFORM-LIQUID"
    Field Value
    Type Description
    String

    Properties

    ContentType

    Gets or sets the content type provided by the source. It controls how that content will be parsed out to an object graph and then provided to Liquid template.

    Declaration
    public LiquidContentType ContentType { get; set; }
    Property Value
    Type Description
    LiquidContentType

    ProcessEmptyContent

    Gets or sets the flag indicating that, if source value is empty, the component should still render the template and assign the result. If False then empty content will be ignored. This property is ignored if ContentType property is set to None, in which case it will be processed regardless of the original content availability. Default is False.

    Declaration
    public bool ProcessEmptyContent { get; set; }
    Property Value
    Type Description
    Boolean

    Template

    Gets or sets the Liquid template.

    Declaration
    public string Template { get; set; }
    Property Value
    Type Description
    String

    Methods

    Equals(MessagePipelineComponentBase)

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

    Declaration
    public override bool Equals(MessagePipelineComponentBase other)
    Parameters
    Type Name Description
    MessagePipelineComponentBase other

    The object to compare with the current object.

    Returns
    Type Description
    Boolean

    True if the specified object is equal to the current object; otherwise, false.

    Overrides
    TransformationComponentBase.Equals(MessagePipelineComponentBase)

    Equals(Object)

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

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj

    The object to compare with the current object.

    Returns
    Type Description
    Boolean

    True if the specified object is equal to the current object; otherwise, false.

    Overrides
    TransformationComponentBase.Equals(Object)

    GetHashCode()

    Returns hash code for the value of this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    Hash code for the value of this instance.

    Overrides
    TransformationComponentBase.GetHashCode()

    ProcessMessage(MessagePipelineContext)

    Transforms the message content using Liquid Template Language.

    Declaration
    public override MessagePipelineResult ProcessMessage(MessagePipelineContext context)
    Parameters
    Type Name Description
    MessagePipelineContext context

    Provides the message processing context.

    Returns
    Type Description
    MessagePipelineResult

    Value indicating if message should continue on its way to the recipient or must be stopped and returned to the sender.

    Overrides
    MessagePipelineComponentBase.ProcessMessage(MessagePipelineContext)

    ToString()

    Returns string representation of the object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    String representing the object's content.

    Overrides
    Object.ToString()

    Validate()

    Evaluates the state of the object.

    Declaration
    public override bool Validate()
    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Overrides
    TransformationComponentBase.Validate()

    Implements

    IValidator
    System.IEquatable<T>
    System.Runtime.Serialization.IExtensibleDataObject
    Back to top Nevatech Sentinet 6.5 Online Documentation