Skip to main content

Class: ActivityHeartbeat

proto.coresdk.ActivityHeartbeat

Represents an ActivityHeartbeat.

Implements

Constructors

constructor

new ActivityHeartbeat(properties?)

Constructs a new ActivityHeartbeat.

Parameters

NameTypeDescription
properties?IActivityHeartbeatProperties to set

Properties

details

details: IPayload[]

ActivityHeartbeat details.

Implementation of

IActivityHeartbeat.details


taskToken

taskToken: Uint8Array

ActivityHeartbeat taskToken.

Implementation of

IActivityHeartbeat.taskToken

Methods

toJSON

toJSON(): Object

Converts this ActivityHeartbeat to JSON.

Returns

Object

JSON object


create

Static create(properties?): ActivityHeartbeat

Creates a new ActivityHeartbeat instance using the specified properties.

Parameters

NameTypeDescription
properties?IActivityHeartbeatProperties to set

Returns

ActivityHeartbeat

ActivityHeartbeat instance


decode

Static decode(reader, length?): ActivityHeartbeat

Decodes an ActivityHeartbeat message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

ActivityHeartbeat

ActivityHeartbeat


decodeDelimited

Static decodeDelimited(reader): ActivityHeartbeat

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

Throws

If the payload is not a reader or valid buffer

Throws

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 coresdk.ActivityHeartbeat.verify|verify messages.

Parameters

NameTypeDescription
messageIActivityHeartbeatActivityHeartbeat message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIActivityHeartbeatActivityHeartbeat message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

ActivityHeartbeat

ActivityHeartbeat


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ActivityHeartbeat

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object