Class EbicsFileTransfer

Inheritance

System.Object

EbicsFileTransfer

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Syntax

public class EbicsFileTransfer

Constructors

EbicsFileTransfer(IEbicsTransport)

Declaration

public EbicsFileTransfer(IEbicsTransport aTransport = null)

Parameters

Type	Name	Description
IEbicsTransport	aTransport

Methods

DownloadFile(EbicsContact, IEbicsSecurityMedium, String, String, DateTime)

Synchronously downloads a data file.

Declaration

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

Parameters

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

Returns

Type	Description
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

Type	Condition
System.ArgumentNullException
System.ArgumentException

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

Declaration

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

Parameters

Type	Name	Description
EbicsContact	aContact
IEbicsSecurityMedium	aSecurityMedium
System.IO.Stream	aStream	Writable destination Stream to write the received data to. This Stream is not disposed by this method.
System.String	sOrderType
System.DateTime	tFrom

Returns

Type	Description
EbicsFileTransferResult

UploadFile(EbicsContact, IEbicsSecurityMedium, String, String, EbicsAuthorisationLevel)

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

Declaration

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

Parameters

Type	Name	Description
EbicsContact	aContact
IEbicsSecurityMedium	aSecurityMedium
System.String	sFilePath
System.String	sOrderType
EbicsAuthorisationLevel	nAuthorisationLevel	The authorisation level for the signature of the order. In order to create a default signature, use the value Null.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
EbicsContact	aContact
IEbicsSecurityMedium	aSecurityMedium
System.IO.Stream	aDataSourceStream
System.String	sOrderType
EbicsAuthorisationLevel	nAuthorisationLevel	The authorisation level for the signature of the order. In order to create a default signature, use the value Null.

Returns

Type	Description
EbicsFileTransferResult