Constructor
new Messages(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new Messages service.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Messages}
Creates new Messages service using the specified rpc implementation.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
| Type | Description |
|---|---|
| Messages |
RPC service. Useful where requests and/or responses are streamed. |
createMessage(request, callback) → {undefined}
Calls CreateMessage.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
enfonica.messaging.v1.ICreateMessageRequest |
CreateMessageRequest message or plain object |
callback |
enfonica.messaging.v1.Messages.CreateMessageCallback |
Node-style callback called with the error, if any, and Message |
Returns:
| Type | Description |
|---|---|
| undefined |
createMessage(request) → {Promise.<enfonica.messaging.v1.Message>}
Calls CreateMessage.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
enfonica.messaging.v1.ICreateMessageRequest |
CreateMessageRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<enfonica.messaging.v1.Message> |
Promise |
getMessage(request, callback) → {undefined}
Calls GetMessage.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
enfonica.messaging.v1.IGetMessageRequest |
GetMessageRequest message or plain object |
callback |
enfonica.messaging.v1.Messages.GetMessageCallback |
Node-style callback called with the error, if any, and Message |
Returns:
| Type | Description |
|---|---|
| undefined |
getMessage(request) → {Promise.<enfonica.messaging.v1.Message>}
Calls GetMessage.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
enfonica.messaging.v1.IGetMessageRequest |
GetMessageRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<enfonica.messaging.v1.Message> |
Promise |
listMessages(request, callback) → {undefined}
Calls ListMessages.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
enfonica.messaging.v1.IListMessagesRequest |
ListMessagesRequest message or plain object |
callback |
enfonica.messaging.v1.Messages.ListMessagesCallback |
Node-style callback called with the error, if any, and ListMessagesResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
listMessages(request) → {Promise.<enfonica.messaging.v1.ListMessagesResponse>}
Calls ListMessages.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
enfonica.messaging.v1.IListMessagesRequest |
ListMessagesRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<enfonica.messaging.v1.ListMessagesResponse> |
Promise |
Type Definitions
CreateMessageCallback(error, responseopt)
Callback as used by enfonica.messaging.v1.Messages#createMessage.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
enfonica.messaging.v1.Message |
<optional> |
Message |
GetMessageCallback(error, responseopt)
Callback as used by enfonica.messaging.v1.Messages#getMessage.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
enfonica.messaging.v1.Message |
<optional> |
Message |
ListMessagesCallback(error, responseopt)
Callback as used by enfonica.messaging.v1.Messages#listMessages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
enfonica.messaging.v1.ListMessagesResponse |
<optional> |
ListMessagesResponse |