io.swagger.client.api

Class MessagesApi

java.lang.Object

io.swagger.client.api.MessagesApi

public class MessagesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MessagesApi()
MessagesApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	orgNameAppNameMessagesPost(String orgName, String appName, String authorization, Msg body) Send a Message Send a message to user(s) and group(s).
com.squareup.okhttp.Call	orgNameAppNameMessagesPostAsync(String orgName, String appName, String authorization, Msg body, ApiCallback<String> callback) Send a Message (asynchronously) Send a message to user(s) and group(s).
ApiResponse<String>	orgNameAppNameMessagesPostWithHttpInfo(String orgName, String appName, String authorization, Msg body) Send a Message Send a message to user(s) and group(s).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessagesApi

public MessagesApi()

MessagesApi

public MessagesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

orgNameAppNameMessagesPost

public String orgNameAppNameMessagesPost(String orgName,
                                String appName,
                                String authorization,
                                Msg body)
                                  throws ApiException

Send a Message Send a message to user(s) and group(s). Please refer to the Hyphenate docs for further details about message body. https://docs.hyphenate.io/docs/post-messages

Parameters:

orgName - Organization ID (required)

appName - Application name (required)

authorization - Bearer ${token} (required)

body - Message types: Text, image, audio message, video, command, etc. Please refer to the Hyphenate docs for further details about message body. https://docs.hyphenate.io/docs/post-messages (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

orgNameAppNameMessagesPostWithHttpInfo

public ApiResponse<String> orgNameAppNameMessagesPostWithHttpInfo(String orgName,
                                                         String appName,
                                                         String authorization,
                                                         Msg body)
                                                           throws ApiException

Send a Message Send a message to user(s) and group(s). Please refer to the Hyphenate docs for further details about message body. https://docs.hyphenate.io/docs/post-messages

Parameters:

orgName - Organization ID (required)

appName - Application name (required)

authorization - Bearer ${token} (required)

body - Message types: Text, image, audio message, video, command, etc. Please refer to the Hyphenate docs for further details about message body. https://docs.hyphenate.io/docs/post-messages (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

orgNameAppNameMessagesPostAsync

public com.squareup.okhttp.Call orgNameAppNameMessagesPostAsync(String orgName,
                                                       String appName,
                                                       String authorization,
                                                       Msg body,
                                                       ApiCallback<String> callback)
                                                         throws ApiException

Send a Message (asynchronously) Send a message to user(s) and group(s). Please refer to the Hyphenate docs for further details about message body. https://docs.hyphenate.io/docs/post-messages

Parameters:

orgName - Organization ID (required)

appName - Application name (required)

authorization - Bearer ${token} (required)

body - Message types: Text, image, audio message, video, command, etc. Please refer to the Hyphenate docs for further details about message body. https://docs.hyphenate.io/docs/post-messages (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object