Class: ActivityCancellationDetails
coresdk.activity_task.ActivityCancellationDetails
Represents an ActivityCancellationDetails.
Implements
Constructors
constructor
• new ActivityCancellationDetails(properties?
): ActivityCancellationDetails
Constructs a new ActivityCancellationDetails.
Parameters
Name | Type | Description |
---|---|---|
properties? | IActivityCancellationDetails | Properties to set |
Returns
Properties
isCancelled
• isCancelled: boolean
ActivityCancellationDetails isCancelled.
Implementation of
IActivityCancellationDetails.isCancelled
isNotFound
• isNotFound: boolean
ActivityCancellationDetails isNotFound.
Implementation of
IActivityCancellationDetails.isNotFound
isPaused
• isPaused: boolean
ActivityCancellationDetails isPaused.
Implementation of
IActivityCancellationDetails.isPaused
isReset
• isReset: boolean
ActivityCancellationDetails isReset.
Implementation of
IActivityCancellationDetails.isReset
isTimedOut
• isTimedOut: boolean
ActivityCancellationDetails isTimedOut.
Implementation of
IActivityCancellationDetails.isTimedOut
isWorkerShutdown
• isWorkerShutdown: boolean
ActivityCancellationDetails isWorkerShutdown.
Implementation of
IActivityCancellationDetails.isWorkerShutdown
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityCancellationDetails to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): ActivityCancellationDetails
Creates a new ActivityCancellationDetails instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IActivityCancellationDetails | Properties to set |
Returns
ActivityCancellationDetails instance
decode
▸ decode(reader
, length?
): ActivityCancellationDetails
Decodes an ActivityCancellationDetails 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
ActivityCancellationDetails
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): ActivityCancellationDetails
Decodes an ActivityCancellationDetails message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityCancellationDetails
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 ActivityCancellationDetails message. Does not implicitly coresdk.activity_task.ActivityCancellationDetails.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IActivityCancellationDetails | ActivityCancellationDetails message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified ActivityCancellationDetails message, length delimited. Does not implicitly coresdk.activity_task.ActivityCancellationDetails.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IActivityCancellationDetails | ActivityCancellationDetails message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): ActivityCancellationDetails
Creates an ActivityCancellationDetails message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
ActivityCancellationDetails
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for ActivityCancellationDetails
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 ActivityCancellationDetails message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | ActivityCancellationDetails | ActivityCancellationDetails |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object