Skip to main content

Class: ActivityHeartbeat

proto.coresdk.ActivityHeartbeat

Represents an ActivityHeartbeat.

Implements#

Constructors#

constructor#

new ActivityHeartbeat(properties?)

Constructs a new ActivityHeartbeat.

Parameters#

NameType
properties?IActivityHeartbeat

Properties#

details#

details: IPayload[]

ActivityHeartbeat details.

Implementation of#

IActivityHeartbeat.details


taskQueue#

taskQueue: string

ActivityHeartbeat taskQueue.

Implementation of#

IActivityHeartbeat.taskQueue


taskToken#

taskToken: Uint8Array

ActivityHeartbeat taskToken.

Implementation of#

IActivityHeartbeat.taskToken

Methods#

toJSON#

toJSON(): Object

Converts this ActivityHeartbeat to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ActivityHeartbeat

Decodes an ActivityHeartbeat message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

ActivityHeartbeat

ActivityHeartbeat


decodeDelimited#

Static decodeDelimited(reader): ActivityHeartbeat

Decodes an ActivityHeartbeat message from the specified reader or buffer, length delimited.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

ActivityHeartbeat

ActivityHeartbeat


encode#

Static encode(message, writer?): Writer

Encodes the specified ActivityHeartbeat message. Does not implicitly {@link coresdk.ActivityHeartbeat.verify|verify} messages.

Parameters#

NameTypeDescription
messageIActivityHeartbeatActivityHeartbeat message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified ActivityHeartbeat message, length delimited. Does not implicitly {@link coresdk.ActivityHeartbeat.verify|verify} messages.

Parameters#

NameTypeDescription
messageIActivityHeartbeatActivityHeartbeat message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ActivityHeartbeat

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ActivityHeartbeat

ActivityHeartbeat


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageActivityHeartbeatActivityHeartbeat
options?IConversionOptions-

Returns#

Object

Plain object