Class: NexusOperationResult
coresdk.nexus.NexusOperationResult
Used by core to resolve nexus operations.
Properties
cancelled
• Optional cancelled: null | $Properties
NexusOperationResult cancelled.
completed
• Optional completed: null | $Properties
NexusOperationResult completed.
failed
• Optional failed: null | $Properties
NexusOperationResult failed.
status
• Optional status: "completed" | "failed" | "cancelled" | "timedOut"
NexusOperationResult status.
timedOut
• Optional timedOut: null | $Properties
NexusOperationResult timedOut.
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationResult & $Shape
Creates a new NexusOperationResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
NexusOperationResult instance
▸ create(properties?): NexusOperationResult
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): NexusOperationResult & $Shape
Decodes a NexusOperationResult message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
NexusOperationResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationResult & $Shape
Decodes a NexusOperationResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified NexusOperationResult message. Does not implicitly coresdk.nexus.NexusOperationResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusOperationResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationResult message, length delimited. Does not implicitly coresdk.nexus.NexusOperationResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusOperationResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationResult
Creates a NexusOperationResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationResult
toObject
▸ toObject(message, options?): Object
Creates a plain object from a NexusOperationResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationResult | NexusOperationResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object