Skip to main content

Class: ActivityHeartbeat

A request as given to record_activity_heartbeat

Properties​

details​

details: $Properties[]

ActivityHeartbeat details.

taskToken​

taskToken: Uint8Array

ActivityHeartbeat taskToken.

Methods​

toJSON()​

toJSON(): object

Converts this ActivityHeartbeat to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityHeartbeat & $Properties

Creates a new ActivityHeartbeat instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityHeartbeat & $Properties

ActivityHeartbeat instance

Call Signature​

static create(properties?): ActivityHeartbeat

Creates a new ActivityHeartbeat instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityHeartbeat

ActivityHeartbeat instance

decode()​

static decode(reader, length?): ActivityHeartbeat & $Properties

Decodes an ActivityHeartbeat message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ActivityHeartbeat & $Properties

ActivityHeartbeat

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityHeartbeat & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityHeartbeat & $Properties

ActivityHeartbeat

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ActivityHeartbeat message. Does not implicitly coresdk.ActivityHeartbeat.verify|verify messages.

Parameters​

message​

$Properties

ActivityHeartbeat message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ActivityHeartbeat message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

Plain 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​

message​

ActivityHeartbeat

ActivityHeartbeat

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object