Skip to content

Latest commit

 

History

History
85 lines (47 loc) · 1.48 KB

DispatchResult.md

File metadata and controls

85 lines (47 loc) · 1.48 KB

o-spreadsheet API / DispatchResult

Class: DispatchResult

Holds the result of a command dispatch. The command may have been successfully dispatched or cancelled for one or more reasons.

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DispatchResult(results?)

Parameters

Name Type Default value
results CommandResult | CommandResult[] []

Properties

reasons

Readonly reasons: CancelledReason[]

Accessors

isSuccessful

get isSuccessful(): boolean

Returns

boolean


Success

Static get Success(): DispatchResult

Static helper which returns a successful DispatchResult

Returns

DispatchResult

Methods

isCancelledBecause

isCancelledBecause(reason): boolean

Check if the dispatch has been cancelled because of the given reason.

Parameters

Name Type
reason CancelledReason

Returns

boolean