Skip to main content

Class: ActivityType

common.v1.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"

Implements

Constructors

constructor

new ActivityType(properties?): ActivityType

Constructs a new ActivityType.

Parameters

NameTypeDescription
properties?IActivityTypeProperties to set

Returns

ActivityType

Properties

name

name: string

ActivityType name.

Implementation of

IActivityType.name

Methods

toJSON

toJSON(): Object

Converts this ActivityType to JSON.

Returns

Object

JSON object


create

create(properties?): ActivityType

Creates a new ActivityType instance using the specified properties.

Parameters

NameTypeDescription
properties?IActivityTypeProperties to set

Returns

ActivityType

ActivityType instance


decode

decode(reader, length?): ActivityType

Decodes an ActivityType message from the specified reader or buffer.

Parameters

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

Returns

ActivityType

ActivityType

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ActivityType

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ActivityType

ActivityType

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

Parameters

NameTypeDescription
messageIActivityTypeActivityType message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIActivityTypeActivityType message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ActivityType

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ActivityType

ActivityType


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ActivityType

Parameters

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

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageActivityTypeActivityType
options?IConversionOptionsConversion options

Returns

Object

Plain object