Skip to main content

Class: Activity

v1.Link.Activity

A link to an activity.

Properties

activityId

activityId: string

Activity activityId.


namespace

namespace: string

Activity namespace.


runId

runId: string

Activity runId.

Methods

toJSON

toJSON(): Object

Converts this Activity to JSON.

Returns

Object

JSON object


create

create(properties?): Activity & $Properties

Creates a new Activity instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

Activity & $Properties

Activity instance

create(properties?): Activity

Parameters

NameType
properties?$Properties

Returns

Activity


decode

decode(reader, length?): Activity & $Properties

Decodes an Activity message from the specified reader or buffer.

Parameters

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

Returns

Activity & $Properties

Activity

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Activity & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Activity & $Properties

Activity

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 Activity message. Does not implicitly temporal.api.common.v1.Link.Activity.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified Activity message, length delimited. Does not implicitly temporal.api.common.v1.Link.Activity.verify|verify messages.

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Activity

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Activity

Activity


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageActivityActivity
options?IConversionOptionsConversion options

Returns

Object

Plain object