docs.DatafeedApi.md Maven / Gradle / Ivy
# DatafeedApi
All URIs are relative to *https://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**v1DatafeedCreatePost**](DatafeedApi.md#v1DatafeedCreatePost) | **POST** /v1/datafeed/create | Create a new real time message event stream.
[**v1DatafeedIdReadGet**](DatafeedApi.md#v1DatafeedIdReadGet) | **GET** /v1/datafeed/{id}/read | Read a given datafeed.
[**v2DatafeedIdReadGet**](DatafeedApi.md#v2DatafeedIdReadGet) | **GET** /v2/datafeed/{id}/read | Read a given datafeed.
# **v1DatafeedCreatePost**
> Datafeed v1DatafeedCreatePost(sessionToken, keyManagerToken)
Create a new real time message event stream.
A datafeed provides the messages in all conversations that a user is in. System messages like new users joining a chatroom are not part of the datafeed. A datafeed will expire after if it isn't read before its capacity is reached.
### Example
```java
// Import classes:
//import org.symphonyoss.symphony.agent.invoker.ApiException;
//import org.symphonyoss.symphony.agent.api.DatafeedApi;
DatafeedApi apiInstance = new DatafeedApi();
String sessionToken = "sessionToken_example"; // String | Session authentication token.
String keyManagerToken = "keyManagerToken_example"; // String | Key Manager authentication token.
try {
Datafeed result = apiInstance.v1DatafeedCreatePost(sessionToken, keyManagerToken);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DatafeedApi#v1DatafeedCreatePost");
e.printStackTrace();
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**sessionToken** | **String**| Session authentication token. |
**keyManagerToken** | **String**| Key Manager authentication token. |
### Return type
[**Datafeed**](Datafeed.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# **v1DatafeedIdReadGet**
> MessageList v1DatafeedIdReadGet(id, sessionToken, keyManagerToken, maxMessages)
Read a given datafeed.
Read messages from the given datafeed. If no more messages are available then this method will block. It is intended that the client should re-call this method as soon as it has processed the messages received in the previous call. If the client is able to consume messages more quickly than they become available then each call will initially block, there is no need to delay before re-calling this method. A datafeed will expire if its unread capacity is reached. A datafeed can only be consumed by one client thread at a time. E.g. polling the datafeed by two threads may lead to messages being delivered out of order.
### Example
```java
// Import classes:
//import org.symphonyoss.symphony.agent.invoker.ApiException;
//import org.symphonyoss.symphony.agent.api.DatafeedApi;
DatafeedApi apiInstance = new DatafeedApi();
String id = "id_example"; // String | Datafeed ID
String sessionToken = "sessionToken_example"; // String | Session authentication token.
String keyManagerToken = "keyManagerToken_example"; // String | Key Manager authentication token.
Integer maxMessages = 56; // Integer | Max No. of messages to return.
try {
MessageList result = apiInstance.v1DatafeedIdReadGet(id, sessionToken, keyManagerToken, maxMessages);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DatafeedApi#v1DatafeedIdReadGet");
e.printStackTrace();
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Datafeed ID |
**sessionToken** | **String**| Session authentication token. |
**keyManagerToken** | **String**| Key Manager authentication token. |
**maxMessages** | **Integer**| Max No. of messages to return. | [optional]
### Return type
[**MessageList**](MessageList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# **v2DatafeedIdReadGet**
> V2MessageList v2DatafeedIdReadGet(id, sessionToken, keyManagerToken, maxMessages)
Read a given datafeed.
Read messages from the given datafeed. If no more messages are available then this method will block. It is intended that the client should re-call this method as soon as it has processed the messages received in the previous call. If the client is able to consume messages more quickly than they become available then each call will initially block, there is no need to delay before re-calling this method. A datafeed will expire if its unread capacity is reached. A datafeed can only be consumed by one client thread at a time. E.g. polling the datafeed by two threads may lead to messages being delivered out of order.
### Example
```java
// Import classes:
//import org.symphonyoss.symphony.agent.invoker.ApiException;
//import org.symphonyoss.symphony.agent.api.DatafeedApi;
DatafeedApi apiInstance = new DatafeedApi();
String id = "id_example"; // String | Datafeed ID
String sessionToken = "sessionToken_example"; // String | Session authentication token.
String keyManagerToken = "keyManagerToken_example"; // String | Key Manager authentication token.
Integer maxMessages = 56; // Integer | Max No. of messages to return.
try {
V2MessageList result = apiInstance.v2DatafeedIdReadGet(id, sessionToken, keyManagerToken, maxMessages);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DatafeedApi#v2DatafeedIdReadGet");
e.printStackTrace();
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Datafeed ID |
**sessionToken** | **String**| Session authentication token. |
**keyManagerToken** | **String**| Key Manager authentication token. |
**maxMessages** | **Integer**| Max No. of messages to return. | [optional]
### Return type
[**V2MessageList**](V2MessageList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json