Class: Success
coresdk.activity_result.Success
Used to report successful completion either when executing or resolving
Implements
Constructors
constructor
• new Success(properties?): Success
Constructs a new Success.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISuccess | Properties to set |
Returns
Properties
result
• Optional result: null | IPayload
Success result.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Success to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Success
Creates a new Success instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISuccess | Properties to set |
Returns
Success instance
decode
▸ decode(reader, length?): Success
Decodes a Success 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
Success
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Success
Decodes a Success message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Success
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 Success message. Does not implicitly coresdk.activity_result.Success.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISuccess | Success message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Success message, length delimited. Does not implicitly coresdk.activity_result.Success.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISuccess | Success message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Success
Creates a Success message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Success
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Success
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 Success message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Success | Success |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object