Class: ActivityExecutionResult
coresdk.activity_result.ActivityExecutionResult
Used to report activity completions to core
Implements
Constructors
constructor
• new ActivityExecutionResult(properties?): ActivityExecutionResult
Constructs a new ActivityExecutionResult.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityExecutionResult | Properties to set |
Returns
Properties
cancelled
• Optional cancelled: null | ICancellation
ActivityExecutionResult cancelled.
Implementation of
IActivityExecutionResult.cancelled
completed
• Optional completed: null | ISuccess
ActivityExecutionResult completed.
Implementation of
IActivityExecutionResult.completed
failed
• Optional failed: null | IFailure
ActivityExecutionResult failed.
Implementation of
IActivityExecutionResult.failed
status
• Optional status: "completed" | "failed" | "cancelled" | "willCompleteAsync"
ActivityExecutionResult status.
willCompleteAsync
• Optional willCompleteAsync: null | IWillCompleteAsync
ActivityExecutionResult willCompleteAsync.
Implementation of
IActivityExecutionResult.willCompleteAsync
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityExecutionResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ActivityExecutionResult
Creates a new ActivityExecutionResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityExecutionResult | Properties to set |
Returns
ActivityExecutionResult instance
decode
▸ decode(reader, length?): ActivityExecutionResult
Decodes an ActivityExecutionResult 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
ActivityExecutionResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityExecutionResult
Decodes an ActivityExecutionResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityExecutionResult
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 ActivityExecutionResult message. Does not implicitly coresdk.activity_result.ActivityExecutionResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityExecutionResult | ActivityExecutionResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityExecutionResult message, length delimited. Does not implicitly coresdk.activity_result.ActivityExecutionResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityExecutionResult | ActivityExecutionResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityExecutionResult
Creates an ActivityExecutionResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityExecutionResult
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ActivityExecutionResult
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ActivityExecutionResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityExecutionResult | ActivityExecutionResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object