Package com.symphony.bdk.gen.api

Class StreamsApi

java.lang.Object
com.symphony.bdk.gen.api.StreamsApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:56.804588655Z[Etc/UTC]") public class StreamsApi extends Object

  • Constructor Details

    • StreamsApi

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

  • Method Details

    • 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(String sessionToken, List<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(String sessionToken, List<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(String id, Boolean active, 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(String id, Boolean active, 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(String id, String sessionToken, Integer skip, 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(String id, String sessionToken, Integer skip, 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(String sessionToken, Integer skip, 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(String sessionToken, Integer skip, 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(String sessionToken, List<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(String sessionToken, List<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(String id, 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(String id, 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(String id, 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(String id, 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(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(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(String id, 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(String id, 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(String id, Boolean active, 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(String id, Boolean active, 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(String id, 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(String id, 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 List<StreamAttributes> v1StreamsListPost(String sessionToken, Integer skip, 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<List<StreamAttributes>> v1StreamsListPostWithHttpInfo(String sessionToken, Integer skip, 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 List<StreamAttachmentItem> v1StreamsSidAttachmentsGet(String sid, String sessionToken, Long since, Long to, Integer limit, 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<List<StreamAttachmentItem>> v1StreamsSidAttachmentsGetWithHttpInfo(String sid, String sessionToken, Long since, Long to, Integer limit, 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(String sid, 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(String sid, 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(String sessionToken, Integer skip, 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(String sessionToken, Integer skip, 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(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(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(String id, 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(String id, 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(String id, 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(String id, 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(String sessionToken, RoomSearchCriteria query, Integer skip, 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(String sessionToken, RoomSearchCriteria query, Integer skip, 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(String sid, 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(String sid, 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(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(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(String id, 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(String id, 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(String id, 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(String id, 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(String sessionToken, V2RoomSearchCriteria query, Integer skip, 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(String sessionToken, V2RoomSearchCriteria query, Integer skip, 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