com.symphony.bdk.gen.api

Class StreamsApi

java.lang.Object

com.symphony.bdk.gen.api.StreamsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-18T12:11:35.250Z[Etc/UTC]")
public class StreamsApi
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.symphony.bdk.http.api.ApiClient	getApiClient() Get the API cilent
void	setApiClient(com.symphony.bdk.http.api.ApiClient apiClient) Set the API cilent
Stream	v1AdminImCreatePost(java.lang.String sessionToken, java.util.List<java.lang.Long> uidList) Create a new single or multi party instant message conversation At least two user IDs must be provided or an error response will be sent.
com.symphony.bdk.http.api.ApiResponse<Stream>	v1AdminImCreatePostWithHttpInfo(java.lang.String sessionToken, java.util.List<java.lang.Long> uidList) Create a new single or multi party instant message conversation At least two user IDs must be provided or an error response will be sent.
RoomDetail	v1AdminRoomIdSetActivePost(java.lang.String id, java.lang.Boolean active, java.lang.String sessionToken) Deactivate or reactivate a chatroom via AC Portal.
com.symphony.bdk.http.api.ApiResponse<RoomDetail>	v1AdminRoomIdSetActivePostWithHttpInfo(java.lang.String id, java.lang.Boolean active, java.lang.String sessionToken) Deactivate or reactivate a chatroom via AC Portal.
V2MembershipList	v1AdminStreamIdMembershipListGet(java.lang.String id, java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit) List the current members of an existing stream.
com.symphony.bdk.http.api.ApiResponse<V2MembershipList>	v1AdminStreamIdMembershipListGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit) List the current members of an existing stream.
AdminStreamList	v1AdminStreamsListPost(java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit, AdminStreamFilter filter) Deprecated.
com.symphony.bdk.http.api.ApiResponse<AdminStreamList>	v1AdminStreamsListPostWithHttpInfo(java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit, AdminStreamFilter filter) Deprecated.
Stream	v1ImCreatePost(java.lang.String sessionToken, java.util.List<java.lang.Long> uidList) Create a new single or multi party instant message conversation between the caller and specified users.
com.symphony.bdk.http.api.ApiResponse<Stream>	v1ImCreatePostWithHttpInfo(java.lang.String sessionToken, java.util.List<java.lang.Long> uidList) Create a new single or multi party instant message conversation between the caller and specified users.
V1IMDetail	v1ImIdInfoGet(java.lang.String id, java.lang.String sessionToken) Get information about a partcular IM.
com.symphony.bdk.http.api.ApiResponse<V1IMDetail>	v1ImIdInfoGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken) Get information about a partcular IM.
V1IMDetail	v1ImIdUpdatePost(java.lang.String id, java.lang.String sessionToken, V1IMAttributes payload) Update the attributes of an existing IM.
com.symphony.bdk.http.api.ApiResponse<V1IMDetail>	v1ImIdUpdatePostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, V1IMAttributes payload) Update the attributes of an existing IM.
RoomDetail	v1RoomCreatePost(java.lang.String sessionToken, RoomCreate payload) Deprecated.
com.symphony.bdk.http.api.ApiResponse<RoomDetail>	v1RoomCreatePostWithHttpInfo(java.lang.String sessionToken, RoomCreate payload) Deprecated.
RoomDetail	v1RoomIdInfoGet(java.lang.String id, java.lang.String sessionToken) Deprecated.
com.symphony.bdk.http.api.ApiResponse<RoomDetail>	v1RoomIdInfoGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken) Deprecated.
RoomDetail	v1RoomIdSetActivePost(java.lang.String id, java.lang.Boolean active, java.lang.String sessionToken) Deactivate or reactivate a chatroom.
com.symphony.bdk.http.api.ApiResponse<RoomDetail>	v1RoomIdSetActivePostWithHttpInfo(java.lang.String id, java.lang.Boolean active, java.lang.String sessionToken) Deactivate or reactivate a chatroom.
RoomDetail	v1RoomIdUpdatePost(java.lang.String id, java.lang.String sessionToken, RoomAttributes payload) Deprecated.
com.symphony.bdk.http.api.ApiResponse<RoomDetail>	v1RoomIdUpdatePostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, RoomAttributes payload) Deprecated.
java.util.List<StreamAttributes>	v1StreamsListPost(java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit, StreamFilter filter) Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).
com.symphony.bdk.http.api.ApiResponse<java.util.List<StreamAttributes>>	v1StreamsListPostWithHttpInfo(java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit, StreamFilter filter) Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).
java.util.List<StreamAttachmentItem>	v1StreamsSidAttachmentsGet(java.lang.String sid, java.lang.String sessionToken, java.lang.Long since, java.lang.Long to, java.lang.Integer limit, java.lang.String sortDir) Get attachments in a particular stream.
com.symphony.bdk.http.api.ApiResponse<java.util.List<StreamAttachmentItem>>	v1StreamsSidAttachmentsGetWithHttpInfo(java.lang.String sid, java.lang.String sessionToken, java.lang.Long since, java.lang.Long to, java.lang.Integer limit, java.lang.String sortDir) Get attachments in a particular stream.
StreamAttributes	v1StreamsSidInfoGet(java.lang.String sid, java.lang.String sessionToken) Deprecated.
com.symphony.bdk.http.api.ApiResponse<StreamAttributes>	v1StreamsSidInfoGetWithHttpInfo(java.lang.String sid, java.lang.String sessionToken) Deprecated.
V2AdminStreamList	v2AdminStreamsListPost(java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit, V2AdminStreamFilter filter) Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range
com.symphony.bdk.http.api.ApiResponse<V2AdminStreamList>	v2AdminStreamsListPostWithHttpInfo(java.lang.String sessionToken, java.lang.Integer skip, java.lang.Integer limit, V2AdminStreamFilter filter) Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range
V2RoomDetail	v2RoomCreatePost(java.lang.String sessionToken, V2RoomAttributes payload) Deprecated.
com.symphony.bdk.http.api.ApiResponse<V2RoomDetail>	v2RoomCreatePostWithHttpInfo(java.lang.String sessionToken, V2RoomAttributes payload) Deprecated.
V2RoomDetail	v2RoomIdInfoGet(java.lang.String id, java.lang.String sessionToken) Deprecated.
com.symphony.bdk.http.api.ApiResponse<V2RoomDetail>	v2RoomIdInfoGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken) Deprecated.
V2RoomDetail	v2RoomIdUpdatePost(java.lang.String id, java.lang.String sessionToken, V2RoomAttributes payload) Deprecated.
com.symphony.bdk.http.api.ApiResponse<V2RoomDetail>	v2RoomIdUpdatePostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, V2RoomAttributes payload) Deprecated.
RoomSearchResults	v2RoomSearchPost(java.lang.String sessionToken, RoomSearchCriteria query, java.lang.Integer skip, java.lang.Integer limit) Deprecated.
com.symphony.bdk.http.api.ApiResponse<RoomSearchResults>	v2RoomSearchPostWithHttpInfo(java.lang.String sessionToken, RoomSearchCriteria query, java.lang.Integer skip, java.lang.Integer limit) Deprecated.
V2StreamAttributes	v2StreamsSidInfoGet(java.lang.String sid, java.lang.String sessionToken) Get information about a partcular stream.
com.symphony.bdk.http.api.ApiResponse<V2StreamAttributes>	v2StreamsSidInfoGetWithHttpInfo(java.lang.String sid, java.lang.String sessionToken) Get information about a partcular stream.
V3RoomDetail	v3RoomCreatePost(java.lang.String sessionToken, V3RoomAttributes payload) Create a new chatroom.
com.symphony.bdk.http.api.ApiResponse<V3RoomDetail>	v3RoomCreatePostWithHttpInfo(java.lang.String sessionToken, V3RoomAttributes payload) Create a new chatroom.
V3RoomDetail	v3RoomIdInfoGet(java.lang.String id, java.lang.String sessionToken) Get information about a partcular chatroom.
com.symphony.bdk.http.api.ApiResponse<V3RoomDetail>	v3RoomIdInfoGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken) Get information about a partcular chatroom.
V3RoomDetail	v3RoomIdUpdatePost(java.lang.String id, java.lang.String sessionToken, V3RoomAttributes payload) Update the attributes of an existing chatroom.
com.symphony.bdk.http.api.ApiResponse<V3RoomDetail>	v3RoomIdUpdatePostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, V3RoomAttributes payload) Update the attributes of an existing chatroom.
V3RoomSearchResults	v3RoomSearchPost(java.lang.String sessionToken, V2RoomSearchCriteria query, java.lang.Integer skip, java.lang.Integer limit) Search rooms according to the specified criteria.
com.symphony.bdk.http.api.ApiResponse<V3RoomSearchResults>	v3RoomSearchPostWithHttpInfo(java.lang.String sessionToken, V2RoomSearchCriteria query, java.lang.Integer skip, java.lang.Integer limit) Search rooms according to the specified criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamsApi

public StreamsApi(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

setApiClient

public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)

Set the API cilent

Parameters:

apiClient - an instance of API client

v1AdminImCreatePost

public Stream v1AdminImCreatePost(java.lang.String sessionToken,
                                  java.util.List<java.lang.Long> uidList)
                           throws com.symphony.bdk.http.api.ApiException

Create a new single or multi party instant message conversation At least two user IDs must be provided or an error response will be sent. The caller is not included in the members of the created chat. Duplicate users will be included in the membership of the chat but the duplication will be silently ignored. If there is an existing IM conversation with the same set of participants then the id of that existing stream will be returned.

Parameters:

sessionToken - Session authentication token. (required)

uidList - List of (integer) User IDs of participants (required)

Returns:

Stream

Throws:

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

v1AdminImCreatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Stream> v1AdminImCreatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                     java.util.List<java.lang.Long> uidList)
                                                                              throws com.symphony.bdk.http.api.ApiException

Create a new single or multi party instant message conversation At least two user IDs must be provided or an error response will be sent. The caller is not included in the members of the created chat. Duplicate users will be included in the membership of the chat but the duplication will be silently ignored. If there is an existing IM conversation with the same set of participants then the id of that existing stream will be returned.

Parameters:

sessionToken - Session authentication token. (required)

uidList - List of (integer) User IDs of participants (required)

Returns:

ApiResponse<Stream>

Throws:

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

v1AdminRoomIdSetActivePost

public RoomDetail v1AdminRoomIdSetActivePost(java.lang.String id,
                                             java.lang.Boolean active,
                                             java.lang.String sessionToken)
                                      throws com.symphony.bdk.http.api.ApiException

Deactivate or reactivate a chatroom via AC Portal.

Parameters:

id - Room streamId (required)

active - (required)

sessionToken - Session authentication token. (required)

Returns:

RoomDetail

Throws:

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

v1AdminRoomIdSetActivePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<RoomDetail> v1AdminRoomIdSetActivePostWithHttpInfo(java.lang.String id,
                                                                                                java.lang.Boolean active,
                                                                                                java.lang.String sessionToken)
                                                                                         throws com.symphony.bdk.http.api.ApiException

Deactivate or reactivate a chatroom via AC Portal.

Parameters:

id - Room streamId (required)

active - (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<RoomDetail>

Throws:

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

v1AdminStreamIdMembershipListGet

public V2MembershipList v1AdminStreamIdMembershipListGet(java.lang.String id,
                                                         java.lang.String sessionToken,
                                                         java.lang.Integer skip,
                                                         java.lang.Integer limit)
                                                  throws com.symphony.bdk.http.api.ApiException

List the current members of an existing stream. The stream can be of type IM, MIM, or ROOM

Parameters:

id - stream Id (required)

sessionToken - Session authentication token. (required)

skip - Number of items to skip. Default is 0. (optional)

limit - Maximum number of items to return. Default is 100 and not to exceed 1000. (optional)

Returns:

V2MembershipList

Throws:

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

v1AdminStreamIdMembershipListGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V2MembershipList> v1AdminStreamIdMembershipListGetWithHttpInfo(java.lang.String id,
                                                                                                            java.lang.String sessionToken,
                                                                                                            java.lang.Integer skip,
                                                                                                            java.lang.Integer limit)
                                                                                                     throws com.symphony.bdk.http.api.ApiException

List the current members of an existing stream. The stream can be of type IM, MIM, or ROOM

Parameters:

id - stream Id (required)

sessionToken - Session authentication token. (required)

skip - Number of items to skip. Default is 0. (optional)

limit - Maximum number of items to return. Default is 100 and not to exceed 1000. (optional)

Returns:

ApiResponse<V2MembershipList>

Throws:

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

v1AdminStreamsListPost

@Deprecated
public AdminStreamList v1AdminStreamsListPost(java.lang.String sessionToken,
                                                          java.lang.Integer skip,
                                                          java.lang.Integer limit,
                                                          AdminStreamFilter filter)
                                                   throws com.symphony.bdk.http.api.ApiException

Deprecated.

Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range

Parameters:

sessionToken - Session authentication token. (required)

skip - Number of items to skip. Default is 0. (optional)

limit - Maximum number of items to return. Default is 50. This value cannot exceed 100. (optional)

filter - Stream filtering criteria. (optional)

Returns:

AdminStreamList

Throws:

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

v1AdminStreamsListPostWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<AdminStreamList> v1AdminStreamsListPostWithHttpInfo(java.lang.String sessionToken,
                                                                                                             java.lang.Integer skip,
                                                                                                             java.lang.Integer limit,
                                                                                                             AdminStreamFilter filter)
                                                                                                      throws com.symphony.bdk.http.api.ApiException

Deprecated.

Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range

Parameters:

sessionToken - Session authentication token. (required)

skip - Number of items to skip. Default is 0. (optional)

limit - Maximum number of items to return. Default is 50. This value cannot exceed 100. (optional)

filter - Stream filtering criteria. (optional)

Returns:

ApiResponse<AdminStreamList>

Throws:

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

v1ImCreatePost

public Stream v1ImCreatePost(java.lang.String sessionToken,
                             java.util.List<java.lang.Long> uidList)
                      throws com.symphony.bdk.http.api.ApiException

Create a new single or multi party instant message conversation between the caller and specified users. At least one user ID must be provided or an error response will be sent. The caller is implicitly included in the members of the created chat. Duplicate users will be included in the membership of the chat but the duplication will be silently ignored. If there is an existing IM conversation with the same set of participants then the id of that existing stream will be returned. This method was incorrectly specified to take a query parameter in version 1.0 of this specification but now expects a JSON array of user IDs in the body of the request.

Parameters:

sessionToken - Session authentication token. (required)

uidList - List of (integer) User IDs of participants (required)

Returns:

Stream

Throws:

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

v1ImCreatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Stream> v1ImCreatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                java.util.List<java.lang.Long> uidList)
                                                                         throws com.symphony.bdk.http.api.ApiException

Create a new single or multi party instant message conversation between the caller and specified users. At least one user ID must be provided or an error response will be sent. The caller is implicitly included in the members of the created chat. Duplicate users will be included in the membership of the chat but the duplication will be silently ignored. If there is an existing IM conversation with the same set of participants then the id of that existing stream will be returned. This method was incorrectly specified to take a query parameter in version 1.0 of this specification but now expects a JSON array of user IDs in the body of the request.

Parameters:

sessionToken - Session authentication token. (required)

uidList - List of (integer) User IDs of participants (required)

Returns:

ApiResponse<Stream>

Throws:

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

v1ImIdInfoGet

public V1IMDetail v1ImIdInfoGet(java.lang.String id,
                                java.lang.String sessionToken)
                         throws com.symphony.bdk.http.api.ApiException

Get information about a partcular IM.

Parameters:

id - IM streamId (required)

sessionToken - Session authentication token. (required)

Returns:

V1IMDetail

Throws:

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

v1ImIdInfoGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V1IMDetail> v1ImIdInfoGetWithHttpInfo(java.lang.String id,
                                                                                   java.lang.String sessionToken)
                                                                            throws com.symphony.bdk.http.api.ApiException

Get information about a partcular IM.

Parameters:

id - IM streamId (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<V1IMDetail>

Throws:

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

v1ImIdUpdatePost

public V1IMDetail v1ImIdUpdatePost(java.lang.String id,
                                   java.lang.String sessionToken,
                                   V1IMAttributes payload)
                            throws com.symphony.bdk.http.api.ApiException

Update the attributes of an existing IM.

Parameters:

id - IM streamID (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

V1IMDetail

Throws:

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

v1ImIdUpdatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V1IMDetail> v1ImIdUpdatePostWithHttpInfo(java.lang.String id,
                                                                                      java.lang.String sessionToken,
                                                                                      V1IMAttributes payload)
                                                                               throws com.symphony.bdk.http.api.ApiException

Update the attributes of an existing IM.

Parameters:

id - IM streamID (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<V1IMDetail>

Throws:

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

v1RoomCreatePost

@Deprecated
public RoomDetail v1RoomCreatePost(java.lang.String sessionToken,
                                               RoomCreate payload)
                                        throws com.symphony.bdk.http.api.ApiException

Deprecated.

Create a new chatroom. Create a new chatroom. If no attributes are specified, the room is created as a private chatroom.

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

RoomDetail

Throws:

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

v1RoomCreatePostWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<RoomDetail> v1RoomCreatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                                  RoomCreate payload)
                                                                                           throws com.symphony.bdk.http.api.ApiException

Deprecated.

Create a new chatroom. Create a new chatroom. If no attributes are specified, the room is created as a private chatroom.

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<RoomDetail>

Throws:

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

v1RoomIdInfoGet

@Deprecated
public RoomDetail v1RoomIdInfoGet(java.lang.String id,
                                              java.lang.String sessionToken)
                                       throws com.symphony.bdk.http.api.ApiException

Deprecated.

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

RoomDetail

Throws:

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

v1RoomIdInfoGetWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<RoomDetail> v1RoomIdInfoGetWithHttpInfo(java.lang.String id,
                                                                                                 java.lang.String sessionToken)
                                                                                          throws com.symphony.bdk.http.api.ApiException

Deprecated.

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<RoomDetail>

Throws:

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

v1RoomIdSetActivePost

public RoomDetail v1RoomIdSetActivePost(java.lang.String id,
                                        java.lang.Boolean active,
                                        java.lang.String sessionToken)
                                 throws com.symphony.bdk.http.api.ApiException

Deactivate or reactivate a chatroom. At creation, a new chatroom is active.

Parameters:

id - Room streamId (required)

active - (required)

sessionToken - Session authentication token. (required)

Returns:

RoomDetail

Throws:

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

v1RoomIdSetActivePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<RoomDetail> v1RoomIdSetActivePostWithHttpInfo(java.lang.String id,
                                                                                           java.lang.Boolean active,
                                                                                           java.lang.String sessionToken)
                                                                                    throws com.symphony.bdk.http.api.ApiException

Deactivate or reactivate a chatroom. At creation, a new chatroom is active.

Parameters:

id - Room streamId (required)

active - (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<RoomDetail>

Throws:

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

v1RoomIdUpdatePost

@Deprecated
public RoomDetail v1RoomIdUpdatePost(java.lang.String id,
                                                 java.lang.String sessionToken,
                                                 RoomAttributes payload)
                                          throws com.symphony.bdk.http.api.ApiException

Deprecated.

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

RoomDetail

Throws:

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

v1RoomIdUpdatePostWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<RoomDetail> v1RoomIdUpdatePostWithHttpInfo(java.lang.String id,
                                                                                                    java.lang.String sessionToken,
                                                                                                    RoomAttributes payload)
                                                                                             throws com.symphony.bdk.http.api.ApiException

Deprecated.

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<RoomDetail>

Throws:

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

v1StreamsListPost

public java.util.List<StreamAttributes> v1StreamsListPost(java.lang.String sessionToken,
                                                          java.lang.Integer skip,
                                                          java.lang.Integer limit,
                                                          StreamFilter filter)
                                                   throws com.symphony.bdk.http.api.ApiException

Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).

Parameters:

sessionToken - Session authentication token. (required)

skip - No. of results to skip. (optional)

limit - Max no. of results to return. If no value is provided, 50 is the default. (optional)

filter - Stream filtering criteria. (optional)

Returns:

List<StreamAttributes>

Throws:

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

v1StreamsListPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<java.util.List<StreamAttributes>> v1StreamsListPostWithHttpInfo(java.lang.String sessionToken,
                                                                                                             java.lang.Integer skip,
                                                                                                             java.lang.Integer limit,
                                                                                                             StreamFilter filter)
                                                                                                      throws com.symphony.bdk.http.api.ApiException

Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).

Parameters:

sessionToken - Session authentication token. (required)

skip - No. of results to skip. (optional)

limit - Max no. of results to return. If no value is provided, 50 is the default. (optional)

filter - Stream filtering criteria. (optional)

Returns:

ApiResponse<List<StreamAttributes>>

Throws:

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

v1StreamsSidAttachmentsGet

public java.util.List<StreamAttachmentItem> v1StreamsSidAttachmentsGet(java.lang.String sid,
                                                                       java.lang.String sessionToken,
                                                                       java.lang.Long since,
                                                                       java.lang.Long to,
                                                                       java.lang.Integer limit,
                                                                       java.lang.String sortDir)
                                                                throws com.symphony.bdk.http.api.ApiException

Get attachments in a particular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

since - Timestamp of first required attachment. This is a long integer value representing milliseconds since Jan 1 1970 (optional)

to - Timestamp of last required attachment. This is a long integer value representing milliseconds since Jan 1 1970 (optional)

limit - Maximum number of attachments to return. Default is 50. Must be a positive integer and must not exceed 100. (optional)

sortDir - Attachment date sort direction : ASC or DESC (default to ASC) (optional)

Returns:

List<StreamAttachmentItem>

Throws:

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

v1StreamsSidAttachmentsGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<java.util.List<StreamAttachmentItem>> v1StreamsSidAttachmentsGetWithHttpInfo(java.lang.String sid,
                                                                                                                          java.lang.String sessionToken,
                                                                                                                          java.lang.Long since,
                                                                                                                          java.lang.Long to,
                                                                                                                          java.lang.Integer limit,
                                                                                                                          java.lang.String sortDir)
                                                                                                                   throws com.symphony.bdk.http.api.ApiException

Get attachments in a particular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

since - Timestamp of first required attachment. This is a long integer value representing milliseconds since Jan 1 1970 (optional)

to - Timestamp of last required attachment. This is a long integer value representing milliseconds since Jan 1 1970 (optional)

limit - Maximum number of attachments to return. Default is 50. Must be a positive integer and must not exceed 100. (optional)

sortDir - Attachment date sort direction : ASC or DESC (default to ASC) (optional)

Returns:

ApiResponse<List<StreamAttachmentItem>>

Throws:

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

v1StreamsSidInfoGet

@Deprecated
public StreamAttributes v1StreamsSidInfoGet(java.lang.String sid,
                                                        java.lang.String sessionToken)
                                                 throws com.symphony.bdk.http.api.ApiException

Deprecated.

Get information about a partcular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

Returns:

StreamAttributes

Throws:

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

v1StreamsSidInfoGetWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<StreamAttributes> v1StreamsSidInfoGetWithHttpInfo(java.lang.String sid,
                                                                                                           java.lang.String sessionToken)
                                                                                                    throws com.symphony.bdk.http.api.ApiException

Deprecated.

Get information about a partcular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<StreamAttributes>

Throws:

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

v2AdminStreamsListPost

public V2AdminStreamList v2AdminStreamsListPost(java.lang.String sessionToken,
                                                java.lang.Integer skip,
                                                java.lang.Integer limit,
                                                V2AdminStreamFilter filter)
                                         throws com.symphony.bdk.http.api.ApiException

Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range

Parameters:

sessionToken - Session authentication token. (required)

skip - Number of items to skip. Default is 0. (optional)

limit - Maximum number of items to return. Default is 50. This value cannot exceed 100. (optional)

filter - Stream filtering criteria. (optional)

Returns:

V2AdminStreamList

Throws:

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

v2AdminStreamsListPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V2AdminStreamList> v2AdminStreamsListPostWithHttpInfo(java.lang.String sessionToken,
                                                                                                   java.lang.Integer skip,
                                                                                                   java.lang.Integer limit,
                                                                                                   V2AdminStreamFilter filter)
                                                                                            throws com.symphony.bdk.http.api.ApiException

Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range

Parameters:

sessionToken - Session authentication token. (required)

skip - Number of items to skip. Default is 0. (optional)

limit - Maximum number of items to return. Default is 50. This value cannot exceed 100. (optional)

filter - Stream filtering criteria. (optional)

Returns:

ApiResponse<V2AdminStreamList>

Throws:

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

v2RoomCreatePost

@Deprecated
public V2RoomDetail v2RoomCreatePost(java.lang.String sessionToken,
                                                 V2RoomAttributes payload)
                                          throws com.symphony.bdk.http.api.ApiException

Deprecated.

Create a new chatroom. Create a new chatroom. If no attributes are specified, the room is created as a private chatroom.

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

V2RoomDetail

Throws:

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

v2RoomCreatePostWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<V2RoomDetail> v2RoomCreatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                                    V2RoomAttributes payload)
                                                                                             throws com.symphony.bdk.http.api.ApiException

Deprecated.

Create a new chatroom. Create a new chatroom. If no attributes are specified, the room is created as a private chatroom.

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<V2RoomDetail>

Throws:

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

v2RoomIdInfoGet

@Deprecated
public V2RoomDetail v2RoomIdInfoGet(java.lang.String id,
                                                java.lang.String sessionToken)
                                         throws com.symphony.bdk.http.api.ApiException

Deprecated.

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

V2RoomDetail

Throws:

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

v2RoomIdInfoGetWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<V2RoomDetail> v2RoomIdInfoGetWithHttpInfo(java.lang.String id,
                                                                                                   java.lang.String sessionToken)
                                                                                            throws com.symphony.bdk.http.api.ApiException

Deprecated.

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<V2RoomDetail>

Throws:

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

v2RoomIdUpdatePost

@Deprecated
public V2RoomDetail v2RoomIdUpdatePost(java.lang.String id,
                                                   java.lang.String sessionToken,
                                                   V2RoomAttributes payload)
                                            throws com.symphony.bdk.http.api.ApiException

Deprecated.

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

V2RoomDetail

Throws:

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

v2RoomIdUpdatePostWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<V2RoomDetail> v2RoomIdUpdatePostWithHttpInfo(java.lang.String id,
                                                                                                      java.lang.String sessionToken,
                                                                                                      V2RoomAttributes payload)
                                                                                               throws com.symphony.bdk.http.api.ApiException

Deprecated.

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<V2RoomDetail>

Throws:

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

v2RoomSearchPost

@Deprecated
public RoomSearchResults v2RoomSearchPost(java.lang.String sessionToken,
                                                      RoomSearchCriteria query,
                                                      java.lang.Integer skip,
                                                      java.lang.Integer limit)
                                               throws com.symphony.bdk.http.api.ApiException

Deprecated.

Search rooms according to the specified criteria.

Parameters:

sessionToken - Session authentication token. (required)

query - The search query object. (required)

skip - No. of results to skip. (optional)

limit - Max no. of results to return. If no value is provided, 50 is the default. Must be a positive integer and must not exceed 100 (optional)

Returns:

RoomSearchResults

Throws:

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

v2RoomSearchPostWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<RoomSearchResults> v2RoomSearchPostWithHttpInfo(java.lang.String sessionToken,
                                                                                                         RoomSearchCriteria query,
                                                                                                         java.lang.Integer skip,
                                                                                                         java.lang.Integer limit)
                                                                                                  throws com.symphony.bdk.http.api.ApiException

Deprecated.

Search rooms according to the specified criteria.

Parameters:

sessionToken - Session authentication token. (required)

query - The search query object. (required)

skip - No. of results to skip. (optional)

limit - Max no. of results to return. If no value is provided, 50 is the default. Must be a positive integer and must not exceed 100 (optional)

Returns:

ApiResponse<RoomSearchResults>

Throws:

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

v2StreamsSidInfoGet

public V2StreamAttributes v2StreamsSidInfoGet(java.lang.String sid,
                                              java.lang.String sessionToken)
                                       throws com.symphony.bdk.http.api.ApiException

Get information about a partcular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

Returns:

V2StreamAttributes

Throws:

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

v2StreamsSidInfoGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V2StreamAttributes> v2StreamsSidInfoGetWithHttpInfo(java.lang.String sid,
                                                                                                 java.lang.String sessionToken)
                                                                                          throws com.symphony.bdk.http.api.ApiException

Get information about a partcular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<V2StreamAttributes>

Throws:

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

v3RoomCreatePost

public V3RoomDetail v3RoomCreatePost(java.lang.String sessionToken,
                                     V3RoomAttributes payload)
                              throws com.symphony.bdk.http.api.ApiException

Create a new chatroom. Create a new chatroom. If no attributes are specified, the room is created as a private chatroom.

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

V3RoomDetail

Throws:

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

v3RoomCreatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V3RoomDetail> v3RoomCreatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                        V3RoomAttributes payload)
                                                                                 throws com.symphony.bdk.http.api.ApiException

Create a new chatroom. Create a new chatroom. If no attributes are specified, the room is created as a private chatroom.

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<V3RoomDetail>

Throws:

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

v3RoomIdInfoGet

public V3RoomDetail v3RoomIdInfoGet(java.lang.String id,
                                    java.lang.String sessionToken)
                             throws com.symphony.bdk.http.api.ApiException

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

V3RoomDetail

Throws:

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

v3RoomIdInfoGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V3RoomDetail> v3RoomIdInfoGetWithHttpInfo(java.lang.String id,
                                                                                       java.lang.String sessionToken)
                                                                                throws com.symphony.bdk.http.api.ApiException

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<V3RoomDetail>

Throws:

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

v3RoomIdUpdatePost

public V3RoomDetail v3RoomIdUpdatePost(java.lang.String id,
                                       java.lang.String sessionToken,
                                       V3RoomAttributes payload)
                                throws com.symphony.bdk.http.api.ApiException

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

V3RoomDetail

Throws:

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

v3RoomIdUpdatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V3RoomDetail> v3RoomIdUpdatePostWithHttpInfo(java.lang.String id,
                                                                                          java.lang.String sessionToken,
                                                                                          V3RoomAttributes payload)
                                                                                   throws com.symphony.bdk.http.api.ApiException

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<V3RoomDetail>

Throws:

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

v3RoomSearchPost

public V3RoomSearchResults v3RoomSearchPost(java.lang.String sessionToken,
                                            V2RoomSearchCriteria query,
                                            java.lang.Integer skip,
                                            java.lang.Integer limit)
                                     throws com.symphony.bdk.http.api.ApiException

Search rooms according to the specified criteria.

Parameters:

sessionToken - Session authentication token. (required)

query - The search query object. (required)

skip - No. of results to skip. (optional)

limit - Max no. of results to return. If no value is provided, 50 is the default. Must be a positive integer and must not exceed 100 (optional)

Returns:

V3RoomSearchResults

Throws:

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

v3RoomSearchPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V3RoomSearchResults> v3RoomSearchPostWithHttpInfo(java.lang.String sessionToken,
                                                                                               V2RoomSearchCriteria query,
                                                                                               java.lang.Integer skip,
                                                                                               java.lang.Integer limit)
                                                                                        throws com.symphony.bdk.http.api.ApiException

Search rooms according to the specified criteria.

Parameters:

sessionToken - Session authentication token. (required)

query - The search query object. (required)

skip - No. of results to skip. (optional)

limit - Max no. of results to return. If no value is provided, 50 is the default. Must be a positive integer and must not exceed 100 (optional)

Returns:

ApiResponse<V3RoomSearchResults>

Throws:

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