com.symphony.bdk.gen.api

Class DatafeedApi

java.lang.Object

com.symphony.bdk.gen.api.DatafeedApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-06-03T09:37:15.620Z[Etc/UTC]")
public class DatafeedApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DatafeedApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
V5Datafeed	createDatafeed(java.lang.String sessionToken, java.lang.String keyManagerToken) Create a new real time messages / events stream (\"datafeed\").
com.symphony.bdk.http.api.ApiResponse<V5Datafeed>	createDatafeedWithHttpInfo(java.lang.String sessionToken, java.lang.String keyManagerToken) Create a new real time messages / events stream (\"datafeed\").
V2Error	deleteDatafeed(java.lang.String datafeedId, java.lang.String sessionToken, java.lang.String keyManagerToken) Delete the specified real time message / event stream (\"datafeed\").
com.symphony.bdk.http.api.ApiResponse<V2Error>	deleteDatafeedWithHttpInfo(java.lang.String datafeedId, java.lang.String sessionToken, java.lang.String keyManagerToken) Delete the specified real time message / event stream (\"datafeed\").
com.symphony.bdk.http.api.ApiClient	getApiClient() Get the API cilent
java.util.List<V5Datafeed>	listDatafeed(java.lang.String sessionToken, java.lang.String keyManagerToken) Read list of real time messages / events stream (\"datafeed\").
com.symphony.bdk.http.api.ApiResponse<java.util.List<V5Datafeed>>	listDatafeedWithHttpInfo(java.lang.String sessionToken, java.lang.String keyManagerToken) Read list of real time messages / events stream (\"datafeed\").
V5EventList	readDatafeed(java.lang.String datafeedId, java.lang.String sessionToken, java.lang.String keyManagerToken, AckId ackId) Read the specified real time message / event stream (\"datafeed\").
com.symphony.bdk.http.api.ApiResponse<V5EventList>	readDatafeedWithHttpInfo(java.lang.String datafeedId, java.lang.String sessionToken, java.lang.String keyManagerToken, AckId ackId) Read the specified real time message / event stream (\"datafeed\").
Datafeed	v4DatafeedCreatePost(java.lang.String sessionToken, java.lang.String keyManagerToken) Create a new real time message event stream.
com.symphony.bdk.http.api.ApiResponse<Datafeed>	v4DatafeedCreatePostWithHttpInfo(java.lang.String sessionToken, java.lang.String keyManagerToken) Create a new real time message event stream.
java.util.List<V4Event>	v4DatafeedIdReadGet(java.lang.String id, java.lang.String sessionToken, java.lang.String keyManagerToken, java.lang.Integer limit) Read a given datafeed.
com.symphony.bdk.http.api.ApiResponse<java.util.List<V4Event>>	v4DatafeedIdReadGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken, java.lang.String keyManagerToken, java.lang.Integer limit) Read a given datafeed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatafeedApi

public DatafeedApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Detail

getApiClient

public com.symphony.bdk.http.api.ApiClient getApiClient()

Get the API cilent

Returns:

API client

createDatafeed

public V5Datafeed createDatafeed(java.lang.String sessionToken,
                                 java.lang.String keyManagerToken)
                          throws com.symphony.bdk.http.api.ApiException

Create a new real time messages / events stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file) Returns the ID of the datafeed that has just been created. This ID should then be used as input to the Read Messages/Events Stream v4 endpoint.

Parameters:

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

V5Datafeed

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

createDatafeedWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V5Datafeed> createDatafeedWithHttpInfo(java.lang.String sessionToken,
                                                                                    java.lang.String keyManagerToken)
                                                                             throws com.symphony.bdk.http.api.ApiException

Create a new real time messages / events stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file) Returns the ID of the datafeed that has just been created. This ID should then be used as input to the Read Messages/Events Stream v4 endpoint.

Parameters:

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

ApiResponse<V5Datafeed>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

deleteDatafeed

public V2Error deleteDatafeed(java.lang.String datafeedId,
                              java.lang.String sessionToken,
                              java.lang.String keyManagerToken)
                       throws com.symphony.bdk.http.api.ApiException

Delete the specified real time message / event stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file) Delete the specified datafeed.

Parameters:

datafeedId - ID of the datafeed (required)

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

V2Error

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

deleteDatafeedWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V2Error> deleteDatafeedWithHttpInfo(java.lang.String datafeedId,
                                                                                 java.lang.String sessionToken,
                                                                                 java.lang.String keyManagerToken)
                                                                          throws com.symphony.bdk.http.api.ApiException

Delete the specified real time message / event stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file) Delete the specified datafeed.

Parameters:

datafeedId - ID of the datafeed (required)

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

ApiResponse<V2Error>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

listDatafeed

public java.util.List<V5Datafeed> listDatafeed(java.lang.String sessionToken,
                                               java.lang.String keyManagerToken)
                                        throws com.symphony.bdk.http.api.ApiException

Read list of real time messages / events stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the [Real Time Events](./docs/real-time-events.md) list. Returns the list of the datafeeds for the user. Any datafeed ID of the list can then be used as input to the Read Messages/Events Stream v4 endpoint.

Parameters:

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

List<V5Datafeed>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

listDatafeedWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<java.util.List<V5Datafeed>> listDatafeedWithHttpInfo(java.lang.String sessionToken,
                                                                                                  java.lang.String keyManagerToken)
                                                                                           throws com.symphony.bdk.http.api.ApiException

Read list of real time messages / events stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the [Real Time Events](./docs/real-time-events.md) list. Returns the list of the datafeeds for the user. Any datafeed ID of the list can then be used as input to the Read Messages/Events Stream v4 endpoint.

Parameters:

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

ApiResponse<List<V5Datafeed>>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

readDatafeed

public V5EventList readDatafeed(java.lang.String datafeedId,
                                java.lang.String sessionToken,
                                java.lang.String keyManagerToken,
                                AckId ackId)
                         throws com.symphony.bdk.http.api.ApiException

Read the specified real time message / event stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file) Read the specified datafeed. The ackId sent as parameter can be empty for the first call. In the response an ackId will be sent back and it can be used for the next call: in this way you acknowledge that you have received the events that came with that ackId; datafeed will remove the events associated with that ackId from your queue

Parameters:

datafeedId - ID of the datafeed (required)

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

ackId - ackId received from last POST Base64 encoded. (optional)

Returns:

V5EventList

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

readDatafeedWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V5EventList> readDatafeedWithHttpInfo(java.lang.String datafeedId,
                                                                                   java.lang.String sessionToken,
                                                                                   java.lang.String keyManagerToken,
                                                                                   AckId ackId)
                                                                            throws com.symphony.bdk.http.api.ApiException

Read the specified real time message / event stream (\"datafeed\"). _Available on Agent 2.57.0 and above._ The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file) Read the specified datafeed. The ackId sent as parameter can be empty for the first call. In the response an ackId will be sent back and it can be used for the next call: in this way you acknowledge that you have received the events that came with that ackId; datafeed will remove the events associated with that ackId from your queue

Parameters:

datafeedId - ID of the datafeed (required)

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

ackId - ackId received from last POST Base64 encoded. (optional)

Returns:

ApiResponse<V5EventList>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v4DatafeedCreatePost

public Datafeed v4DatafeedCreatePost(java.lang.String sessionToken,
                                     java.lang.String keyManagerToken)
                              throws com.symphony.bdk.http.api.ApiException

Create a new real time message event stream. A datafeed provides the messages in all conversations that a user is in. This also includes system messages like new users joining a chatroom. A datafeed will expire if it isn't read before its capacity is reached.

Parameters:

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

Datafeed

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v4DatafeedCreatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Datafeed> v4DatafeedCreatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                        java.lang.String keyManagerToken)
                                                                                 throws com.symphony.bdk.http.api.ApiException

Create a new real time message event stream. A datafeed provides the messages in all conversations that a user is in. This also includes system messages like new users joining a chatroom. A datafeed will expire if it isn't read before its capacity is reached.

Parameters:

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

Returns:

ApiResponse<Datafeed>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v4DatafeedIdReadGet

public java.util.List<V4Event> v4DatafeedIdReadGet(java.lang.String id,
                                                   java.lang.String sessionToken,
                                                   java.lang.String keyManagerToken,
                                                   java.lang.Integer limit)
                                            throws com.symphony.bdk.http.api.ApiException

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.

Parameters:

id - Datafeed ID (required)

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

limit - Max No. of messages to return. (optional)

Returns:

List<V4Event>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v4DatafeedIdReadGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<java.util.List<V4Event>> v4DatafeedIdReadGetWithHttpInfo(java.lang.String id,
                                                                                                      java.lang.String sessionToken,
                                                                                                      java.lang.String keyManagerToken,
                                                                                                      java.lang.Integer limit)
                                                                                               throws com.symphony.bdk.http.api.ApiException

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.

Parameters:

id - Datafeed ID (required)

sessionToken - Session authentication token. (required)

keyManagerToken - Key Manager authentication token. (required)

limit - Max No. of messages to return. (optional)

Returns:

ApiResponse<List<V4Event>>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call