Interface IBackupService

Namespace

Ecng.Backup

Assembly

Ecng.Backup.dll

The interface describing online data storage service.

public interface IBackupService : IDisposable

Inherited Members

IDisposable.Dispose()

Extension Methods

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Properties

CanFolders

Is folders feature available.

bool CanFolders { get; }

Property Value

bool

CanPartialDownload

Is partial download feature available.

bool CanPartialDownload { get; }

Property Value

bool

CanPublish

Is publishing feature available.

bool CanPublish { get; }

Property Value

bool

Methods

CreateFolder(BackupEntry, CancellationToken)

Is partial upload feature available.

Task CreateFolder(BackupEntry entry, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

BackupEntry

cancellationToken CancellationToken

CancellationToken

Returns

Task

Task

DeleteAsync(BackupEntry, CancellationToken)

Delete file from the service.

Task DeleteAsync(BackupEntry entry, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

Element.

cancellationToken CancellationToken

CancellationToken

Returns

Task

Task

DownloadAsync(BackupEntry, Stream, long?, long?, Action<int>, CancellationToken)

Save file.

Task DownloadAsync(BackupEntry entry, Stream stream, long? offset, long? length, Action<int> progress, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

Element.

stream Stream

offset long?

length long?

progress Action<int>

Progress notification.

cancellationToken CancellationToken

CancellationToken

Returns

Task

Task

FillInfoAsync(BackupEntry, CancellationToken)

Fill file info.

Task FillInfoAsync(BackupEntry entry, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

Element.

cancellationToken CancellationToken

CancellationToken

Returns

Task

Task

FindAsync(BackupEntry, string, CancellationToken)

Find files by the specified criteria.

IAsyncEnumerable<BackupEntry> FindAsync(BackupEntry parent, string criteria, CancellationToken cancellationToken = default)

Parameters

parent BackupEntry

Parent element. Can be null.

criteria string

Criteria.

cancellationToken CancellationToken

CancellationToken

Returns

IAsyncEnumerable<BackupEntry>

File list.

PublishAsync(BackupEntry, CancellationToken)

Get public url for the specified element.

Task<string> PublishAsync(BackupEntry entry, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

Element.

cancellationToken CancellationToken

CancellationToken

Returns

Task<string>

Public url.

UnPublishAsync(BackupEntry, CancellationToken)

Remove public url for the specified element.

Task UnPublishAsync(BackupEntry entry, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

Element.

cancellationToken CancellationToken

CancellationToken

Returns

Task

Task

UploadAsync(BackupEntry, Stream, Action<int>, CancellationToken)

Upload file.

Task UploadAsync(BackupEntry entry, Stream stream, Action<int> progress, CancellationToken cancellationToken = default)

Parameters

entry BackupEntry

Element.

stream Stream

The stream of the open file into which data from the service will be downloaded.

progress Action<int>

Progress notification.

cancellationToken CancellationToken

CancellationToken

Returns

Task

Task