Skip to main content

Class: ActivityType

Represents the identifier used by a activity author to define the activity. Typically, the name of a function. This is sometimes referred to as the activity's "name"

Properties​

name​

name: string

ActivityType name.

Methods​

toJSON()​

toJSON(): object

Converts this ActivityType to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityType & $Properties

Creates a new ActivityType instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityType & $Properties

ActivityType instance

Call Signature​

static create(properties?): ActivityType

Creates a new ActivityType instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityType

ActivityType instance

decode()​

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

Decodes an ActivityType 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​

ActivityType & $Properties

ActivityType

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityType & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityType & $Properties

ActivityType

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

Parameters​

message​

$Properties

ActivityType message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ActivityType message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ActivityType

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ActivityType

ActivityType

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ActivityType

ActivityType

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object