• Articles
  • Api Documentation

    Show / Hide Table of Contents
    • Yort.Laybuy.InStore
      • CancelOrderRequest
      • CancelOrderResponse
      • CreateOrderRequest
      • CreateOrderResponse
      • ILaybuyClient
      • LaybuyApiException
      • LaybuyApiResponseBase
      • LaybuyClient
      • LaybuyClientConfiguration
      • LaybuyCredentials
      • LaybuyCustomerAddress
      • LaybuyCustomerBase
      • LaybuyEnvironment
      • LaybuyItem
      • LaybuyOrderRefund
      • LaybuyOrderStatus
      • LaybuyRequestBase
      • LaybuyStatus
      • OrderRequest
      • OrderResponse
      • OrderStatusRequest
      • OrderStatusResponse
      • RefundRequest
      • RefundResponse
      • RequestLaybuyCustomer
      • ResponseLaybuyCustomer
      • StandardOriginData

    Class LaybuyRequestBase

    Base class for request objects, used to provide some internal plumbing. Not intended for use from application code.

    Inheritance
    Object
    LaybuyRequestBase
    CancelOrderRequest
    CreateOrderRequest
    OrderRequest
    OrderStatusRequest
    RefundRequest
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Yort.Laybuy.InStore
    Assembly: Yort.Laybuy.InStore.dll
    Syntax
    public abstract class LaybuyRequestBase

    Methods

    | Improve this Doc View Source

    SetDefaults(LaybuyClientConfiguration)

    Sets any properties on this object that are null to the appropriate defaults, if possible.

    Declaration
    public virtual void SetDefaults(LaybuyClientConfiguration settings)
    Parameters
    Type Name Description
    LaybuyClientConfiguration settings

    The settings used to construct the LaybuyClient instance that is about to send this request.

    Remarks

    The base implementation of this method does nothing, it should be overriden by derived classes that have defaults which can have suitable defaults applied. This method is not abstract so as not to force derived classes to implement and document an empty versions when there are no defaults that can be applied.

    | Improve this Doc View Source

    Validate()

    Validates the properties for this instance are valid before sending the request to the API.

    Declaration
    public abstract void Validate()
    Remarks

    Provides simple client side validation, such as required fields beign provided and fields under maximum lengths etc.

    • Improve this Doc
    • View Source
    Back to top Copyright (c) 2020 Troy Willmot