Skip to main content

Class: RequestCancelActivity

coresdk.workflow_commands.RequestCancelActivity

Represents a RequestCancelActivity.

Properties​

seq​

• seq: number

Lang's incremental sequence number as passed to ScheduleActivity

Methods​

toJSON​

▸ toJSON(): Object

Converts this RequestCancelActivity to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): RequestCancelActivity & $Properties

Creates a new RequestCancelActivity instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

RequestCancelActivity & $Properties

RequestCancelActivity instance

▸ create(properties?): RequestCancelActivity

Parameters​

NameType
properties?$Properties

Returns​

RequestCancelActivity


decode​

▸ decode(reader, length?): RequestCancelActivity & $Properties

Decodes a RequestCancelActivity message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

RequestCancelActivity & $Properties

RequestCancelActivity

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): RequestCancelActivity & $Properties

Decodes a RequestCancelActivity message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

RequestCancelActivity & $Properties

RequestCancelActivity

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 RequestCancelActivity message. Does not implicitly coresdk.workflow_commands.RequestCancelActivity.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesRequestCancelActivity message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified RequestCancelActivity message, length delimited. Does not implicitly coresdk.workflow_commands.RequestCancelActivity.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesRequestCancelActivity message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): RequestCancelActivity

Creates a RequestCancelActivity message from a plain object. Also converts values to their respective internal types.

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

RequestCancelActivity

RequestCancelActivity


toObject​

▸ toObject(message, options?): Object

Creates a plain object from a RequestCancelActivity message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageRequestCancelActivityRequestCancelActivity
options?IConversionOptionsConversion options

Returns​

Object

Plain object