Class: ActivityHeartbeat
proto.coresdk.ActivityHeartbeat
A request as given to record_activity_heartbeat
Implements
Constructors
constructor
• new ActivityHeartbeat(properties?): ActivityHeartbeat
Constructs a new ActivityHeartbeat.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityHeartbeat | Properties to set |
Returns
Properties
details
• details: IPayload[]
ActivityHeartbeat details.
Implementation of
taskToken
• taskToken: Uint8Array
ActivityHeartbeat taskToken.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityHeartbeat to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ActivityHeartbeat
Creates a new ActivityHeartbeat instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityHeartbeat | Properties to set |
Returns
ActivityHeartbeat instance
decode
▸ decode(reader, length?): ActivityHeartbeat
Decodes an ActivityHeartbeat 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
ActivityHeartbeat
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityHeartbeat
Decodes an ActivityHeartbeat message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityHeartbeat
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 ActivityHeartbeat message. Does not implicitly coresdk.ActivityHeartbeat.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityHeartbeat | ActivityHeartbeat message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityHeartbeat message, length delimited. Does not implicitly coresdk.ActivityHeartbeat.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityHeartbeat | ActivityHeartbeat message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityHeartbeat
Creates an ActivityHeartbeat message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityHeartbeat
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ActivityHeartbeat
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 an ActivityHeartbeat message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityHeartbeat | ActivityHeartbeat |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object