Class: Manual
PendingActivityInfo.PauseInfo.Manual
Represents a Manual.
Implements
Constructors
constructor
• new Manual(properties?): Manual
Constructs a new Manual.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IManual | Properties to set |
Returns
Properties
identity
• identity: string
The identity of the actor that paused the activity.
Implementation of
reason
• reason: string
Reason for pausing the activity.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Manual to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Manual
Creates a new Manual instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IManual | Properties to set |
Returns
Manual instance
decode
▸ decode(reader, length?): Manual
Decodes a Manual message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Manual
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Manual
Decodes a Manual message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Manual
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 Manual message. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.PauseInfo.Manual.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IManual | Manual message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Manual message, length delimited. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.PauseInfo.Manual.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IManual | Manual message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Manual
Creates a Manual message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Manual
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Manual
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Manual message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Manual | Manual |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object