Class EbicsFileTransfer

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

public class EbicsFileTransfer

Inheritance: object

EbicsFileTransfer

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EbicsFileTransfer(IEbicsTransport)

public EbicsFileTransfer(IEbicsTransport aTransport = null)

Parameters

aTransport IEbicsTransport

Methods

DownloadFile(EbicsContact, IEbicsSecurityMedium, string, string, DateTime)

Synchronously downloads a data file.

public EbicsFileTransferResult DownloadFile(EbicsContact aContact, IEbicsSecurityMedium aSecurityMedium, string sFilePath, string sOrderType, DateTime tFrom)

Parameters

aContact EbicsContact: The EbicsContact that shall be used to download. Must not be null.
aSecurityMedium IEbicsSecurityMedium: An authenticated security medium for the given contact. Must not be null.
sFilePath string: The destination file path and file name where new data files shall be stored. Must not be null.
sOrderType string
tFrom DateTime: Start date. If this is DateTime.MinValue, then no date range will be specified for the download request.

Returns

EbicsFileTransferResult

Remarks

This method performs a single EBICS transaction downloading all data from tFrom to today. The received data is stored in the given sFilePath.

Exceptions

ArgumentNullException
ArgumentException

DownloadStream(EbicsContact, IEbicsSecurityMedium, Stream, string, DateTime)

public EbicsFileTransferResult DownloadStream(EbicsContact aContact, IEbicsSecurityMedium aSecurityMedium, Stream aStream, string sOrderType, DateTime tFrom)

Parameters

aContact EbicsContact
aSecurityMedium IEbicsSecurityMedium
aStream Stream: Writable destination Stream to write the received data to. This Stream is not disposed by this method.
sOrderType string
tFrom DateTime

Returns

EbicsFileTransferResult

UploadFile(EbicsContact, IEbicsSecurityMedium, string, string, EbicsAuthorisationLevel)

Synchronously uploads the referenced data file from the given data folder.

public EbicsFileTransferResult UploadFile(EbicsContact aContact, IEbicsSecurityMedium aSecurityMedium, string sFilePath, string sOrderType, EbicsAuthorisationLevel nAuthorisationLevel = EbicsAuthorisationLevel.Null)

Parameters

aContact EbicsContact
aSecurityMedium IEbicsSecurityMedium
sFilePath string
sOrderType string
nAuthorisationLevel EbicsAuthorisationLevel: The authorisation level for the signature of the order. In order to create a default signature, use the value Null.

Returns

EbicsFileTransferResult

Remarks

This method exclusively locks the file to be uploaded for the duration of the upload. This shall prevent that the same file is uploaded simultaneously. If uploading fails and there was no receipt phase, then the file is released without modification. If uploading was successful and there was a receipt acknowledgement, then the file is ...

UploadStream(EbicsContact, IEbicsSecurityMedium, Stream, string, EbicsAuthorisationLevel)

Synchronously uploads the given data stream.

public EbicsFileTransferResult UploadStream(EbicsContact aContact, IEbicsSecurityMedium aSecurityMedium, Stream aDataSourceStream, string sOrderType, EbicsAuthorisationLevel nAuthorisationLevel = EbicsAuthorisationLevel.Null)

Parameters

aContact EbicsContact
aSecurityMedium IEbicsSecurityMedium
aDataSourceStream Stream
sOrderType string
nAuthorisationLevel EbicsAuthorisationLevel: The authorisation level for the signature of the order. In order to create a default signature, use the value Null.

Returns

EbicsFileTransferResult