Class AsyncControlBase<TResult>

A base class for the implementation of asynchronous processing.

Inheritance
Object
AsyncControlBase<TResult>
AuthorizeAsyncControl
FetchFilesAsyncControl
FetchSheetsAsyncControl
FetchSheetValuesAsyncControl
Implements
Namespace: GoogleSheetFetcher.Editor.AsyncControls
Assembly: GoogleSheetFetcher.Editor.dll
Syntax
public abstract class AsyncControlBase<TResult> : IAsyncControl
Type Parameters
Name Description
TResult

Properties

| Improve this Doc View Source

CancellationToken

Declaration
protected CancellationToken CancellationToken { get; }
Property Value
Type Description
CancellationToken
| Improve this Doc View Source

Exception

The exception when the processing failure.

Declaration
public Exception Exception { get; }
Property Value
Type Description
Exception
| Improve this Doc View Source

IsDone

Whether or not the process completed.

Declaration
public bool IsDone { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Progress

Declaration
protected virtual float Progress { get; }
Property Value
Type Description
Single
| Improve this Doc View Source

Result

The result of the processing.

Declaration
public TResult Result { get; }
Property Value
Type Description
TResult
| Improve this Doc View Source

Status

The state of asynchronous processing.

Declaration
public AsyncControlStatus Status { get; }
Property Value
Type Description
AsyncControlStatus
| Improve this Doc View Source

Task

Task

Declaration
public Task<TResult> Task { get; }
Property Value
Type Description
Task<TResult>

Methods

| Improve this Doc View Source

Cancel()

Cancel processing.

Declaration
public void Cancel()
| Improve this Doc View Source

Failed(Exception)

Declaration
protected void Failed(Exception exception)
Parameters
Type Name Description
Exception exception
| Improve this Doc View Source

GetProgress()

Get the progress of the process.

Declaration
public float GetProgress()
Returns
Type Description
Single
| Improve this Doc View Source

OnStart()

Declaration
protected abstract void OnStart()
| Improve this Doc View Source

Start()

Start processing.

Declaration
public void Start()
| Improve this Doc View Source

Succeeded(TResult)

Declaration
protected void Succeeded(TResult result)
Parameters
Type Name Description
TResult result

Events

| Improve this Doc View Source

Completed

The event that is called at the end of the process.

Declaration
public event Action Completed
Event Type
Type Description
Action

Explicit Interface Implementations

| Improve this Doc View Source

IAsyncControl.Task

Declaration
Task IAsyncControl.Task { get; }
Returns
Type Description
Task

Implements