Show / Hide Table of Contents
    • Yort.LatitudePay.InStore
      • ILatitudePayClient
      • ILatitudePaySignatureGenerator
      • ILatitudePaySystemClock
      • LatitiudePayShippingLine
      • LatitudePayAddress
      • LatitudePayApiException
      • LatitudePayAuthToken
      • LatitudePayAvailability
      • LatitudePayCancelPurchaseRequest
      • LatitudePayCancelPurchaseResponse
      • LatitudePayClient
      • LatitudePayClientConfiguration
      • LatitudePayConfigurationRequest
      • LatitudePayConfigurationResponse
      • LatitudePayConstants
      • LatitudePayCreatePosPurchaseRequest
      • LatitudePayCreatePosPurchaseResponse
      • LatitudePayCreateRefundRequest
      • LatitudePayCreateRefundResponse
      • LatitudePayCurrencies
      • LatitudePayCustomer
      • LatitudePayEnvironment
      • LatitudePayHMACSHA256SignatureGenerator
      • LatitudePayMoney
      • LatitudePayProduct
      • LatitudePayPurchaseStatusRequest
      • LatitudePayPurchaseStatusResponse
      • LatitudePayReturnUrls
      • LatitudePaySystemClock

    Class LatitudePayAuthToken

    Represents a token returned from the LatitudePay Authorization endpoint.

    Inheritance
    Object
    LatitudePayAuthToken
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Yort.LatitudePay.InStore
    Assembly: Yort.LatitudePay.InStore.dll
    Syntax
    public class LatitudePayAuthToken
    Remarks

    This class is used internally by LatitudePayClient which will automatically request and renew tokens as required. It is not expected to be used directly by application code.

    Properties

    | Improve this Doc View Source

    ExpiryDate

    Gets or sets the date and time at which this token expires.

    Declaration
    [JsonProperty("expiryDate")]
    public DateTimeOffset ExpiryDate { get; set; }
    Property Value
    Type Description
    DateTimeOffset

    The expiry date and time.

    | Improve this Doc View Source

    Token

    Gets or sets the authorization token return by LatitudePay.

    Declaration
    [JsonProperty("authToken")]
    public string Token { get; set; }
    Property Value
    Type Description
    String

    The token.

    Methods

    | Improve this Doc View Source

    IsValid(ILatitudePaySystemClock)

    Returns a boolean indicating if this Token value should currently be usable with the LatitudePay API.

    Declaration
    public bool IsValid(ILatitudePaySystemClock clock)
    Parameters
    Type Name Description
    ILatitudePaySystemClock clock

    An instance implementing ILatitudePaySystemClock used to determine the current time.

    Returns
    Type Description
    Boolean

    true if the specified clock is valid; otherwise, false.

    Remarks

    Returns true if clock is not empty and the current time (using clock) is more than one minute before ExpiryDate.

    If clock is null then DefaultInstance is used.

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