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