ShippoSystem MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The ShippoSystem type exposes the following members.
Constructors

  NameDescription
Public methodShippoSystem(String, IConfigSectionNode)
Initializes a new instance of the ShippoSystem class
Public methodShippoSystem(String, IConfigSectionNode, Object)
Initializes a new instance of the ShippoSystem class
Back to Top
Methods

  NameDescription
Protected method____ObtainPrivateServiceStatusLockObject
WARNING: Developers never call this method!!! It is used by advanced derived implementations that need to synchronize status updates. We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.)
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Protected methodAbortStart
Allows to abort unsuccessful DoStart() overridden implementation. This method must be called from within DoStart()
(Inherited from Service.)
Public methodAcceptManagerVisit
Accepts a visit of a manager entity - this call is useful for periodic updates of service status, i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method. The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.)
Public methodCheckForCompleteStop
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.)
Protected methodCheckServiceActive
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.)
Protected methodCheckServiceActiveOrStarting
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.)
Protected methodCheckServiceInactive
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.)
Public methodConfigure
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.)
Public methodCreateLabel(ShippingSession, IShippingContext, Shipment) (Overrides ShippingSystem CreateLabel(ShippingSession, IShippingContext, Shipment).)
Public methodCreateLabel(ShippoSession, IShippingContext, Shipment)
Protected methodDestructor (Inherited from ShippingSystem.)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoAcceptManagerVisit (Inherited from ShippingSystem.)
Protected methodDoCheckForCompleteStop
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.)
Protected methodDoConfigure (Inherited from ShippingSystem.)
Protected methodDoSignalStop
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.)
Protected methodDoStart (Inherited from ShippingSystem.)
Protected methodDoStartSession (Overrides ShippingSystem DoStartSession(ShippingConnectionParameters).)
Protected methodDoWaitForCompleteStop (Inherited from ShippingSystem.)
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Public methodEstimateShippingCost(ShippingSession, IShippingContext, Shipment) (Overrides ShippingSystem EstimateShippingCost(ShippingSession, IShippingContext, Shipment).)
Public methodEstimateShippingCost(ShippoSession, IShippingContext, Shipment)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public methodExternalParametersForGroups
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public methodExternalSetParameter
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .)
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodGetShippingCarriers (Inherited from ShippingSystem.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodLocalizedTimeToUniversalTime
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.)
Protected methodLog (Inherited from ShippingSystem.)
Protected methodMakeDefaultSessionConnectParams (Overrides ShippingSystem MakeDefaultSessionConnectParams(IConfigSectionNode).)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodSignalStop
Non-blocking call that initiates the stopping of the service
(Inherited from Service.)
Public methodStart
Blocking call that starts the service instance
(Inherited from Service.)
Protected methodStartByApplication
Blocking call that starts the service instance
(Inherited from Service.)
Public methodStartSession (Inherited from ShippingSystem.)
Protected methodStatCreateLabel (Inherited from ShippingSystem.)
Protected methodStatCreateLabelError (Inherited from ShippingSystem.)
Protected methodStatEstimateShippingCostCount (Inherited from ShippingSystem.)
Protected methodStatEstimateShippingCostErrorCount (Inherited from ShippingSystem.)
Protected methodStatTrackShipmentCount (Inherited from ShippingSystem.)
Protected methodStatTrackShipmentErrorCount (Inherited from ShippingSystem.)
Protected methodStatValidateAddressCount (Inherited from ShippingSystem.)
Protected methodStatValidateAddressErrorCount (Inherited from ShippingSystem.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodTrackShipment(ShippingSession, IShippingContext, String, String) (Overrides ShippingSystem TrackShipment(ShippingSession, IShippingContext, String, String).)
Public methodTrackShipment(ShippoSession, IShippingContext, String, String)
Public methodUniversalTimeToLocalizedTime
Converts universal time to local time as of TimeLocation property
(Inherited from Service.)
Public methodValidateAddress(ShippingSession, IShippingContext, Address, ValidateShippingAddressException ) (Overrides ShippingSystem ValidateAddress(ShippingSession, IShippingContext, Address, ValidateShippingAddressException ).)
Public methodValidateAddress(ShippoSession, IShippingContext, Address, ValidateShippingAddressException )
Public methodWaitForCompleteStop
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberCARRIERS
Public fieldStatic memberCODE_INVALID
Public fieldStatic memberDIST_UNITS
Public fieldStatic memberFORMATS
Public fieldStatic memberHDR_AUTHORIZATION
Public fieldStatic memberHDR_AUTHORIZATION_TOKEN
Public fieldStatic memberMASS_UNITS
Public fieldStatic memberPURCHASE_PURPOSE
Public fieldStatic memberQUOTE_PURPOSE
Public fieldStatic memberSHIPPO_REALM
Public fieldStatic memberSTATUS_ERROR
Public fieldStatic memberSTATUS_INVALID
Public fieldStatic memberSTATUS_SUCCESS
Public fieldStatic memberSTATUS_VALID
Public fieldStatic memberTRACK_STATUSES
Public fieldStatic memberURI_ADDRESS
Public fieldStatic memberURI_API_BASE
Public fieldStatic memberURI_RATES
Public fieldStatic memberURI_SHIPMENTS
Public fieldStatic memberURI_TRACKING
Public fieldStatic memberURI_TRACKING_FORM
Public fieldStatic memberURI_TRANSACTIONS
Back to Top
Properties

  NameDescription
Public propertyApplicationDontAutoStartService
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.)
Public propertyComponentCommonName
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations. This name is searched-by some management tools that allow to find component by this name that does not change between application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.)
Public propertyComponentDirector (Inherited from Service TDirector .)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Protected propertyDefaultSessionConnectParams (Inherited from ShippingSystem.)
Public propertyDefaultSessionConnectParamsCfg (Inherited from ShippingSystem.)
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyExternalParameters
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public propertyInstrumentationEnabled (Inherited from ShippingSystem.)
Public propertyKeepAlive (Inherited from ShippingSystem.)
Public propertyLocalizedTime
Returns current time localized per TimeLocation
(Inherited from Service.)
Public propertyLogLevel (Inherited from ShippingSystem.)
Public propertyName
Provides textual name for the service
(Inherited from Service.)
Public propertyPipelined (Inherited from ShippingSystem.)
Public propertyRunning
Returns true when service is active or about to become active. Check in service implementation loops/threads/tasks
(Inherited from Service.)
Protected propertySessions (Inherited from ShippingSystem.)
Public propertyStatus
Current service status
(Inherited from Service.)
Public propertyTimeLocation
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.)
Public propertyWebServiceCallTimeoutMs (Inherited from ShippingSystem.)
Back to Top
See Also