org.symphonyoss.symphony.pod.api

Class StreamsApi

java.lang.Object

org.symphonyoss.symphony.pod.api.StreamsApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-12-17T23:29:05.070-05:00")
public class StreamsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
StreamsApi()
StreamsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
Stream	v1AdminImCreatePost(UserIdList uidList, String sessionToken) 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.
V2MembershipList	v1AdminStreamIdMembershipListGet(String id, String sessionToken, Integer skip, Integer limit) List the current members of an existing stream.
AdminStreamList	v1AdminStreamsListPost(String sessionToken, Integer skip, Integer limit, AdminStreamFilter filter) Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given time range
Stream	v1ImCreatePost(UserIdList uidList, String sessionToken) Create a new single or multi party instant message conversation between the caller and specified users.
RoomDetail	v1RoomCreatePost(RoomCreate payload, String sessionToken) Create a new chatroom.
RoomDetail	v1RoomIdInfoGet(String id, String sessionToken) Get information about a partcular chatroom.
RoomDetail	v1RoomIdSetActivePost(String id, Boolean active, String sessionToken) Deactivate or reactivate a chatroom.
RoomDetail	v1RoomIdUpdatePost(String id, RoomAttributes payload, String sessionToken) Update the attributes of an existing chatroom.
StreamList	v1StreamsListPost(String sessionToken, Integer skip, Integer limit, StreamFilter filter) Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).
StreamAttributes	v1StreamsSidInfoGet(String sid, String sessionToken) Get information about a partcular stream.
V2RoomDetail	v2RoomCreatePost(V2RoomAttributes payload, String sessionToken) Create a new chatroom.
V2RoomDetail	v2RoomIdInfoGet(String id, String sessionToken) Get information about a partcular chatroom.
V2RoomDetail	v2RoomIdUpdatePost(String id, V2RoomAttributes payload, String sessionToken) Update the attributes of an existing chatroom.
RoomSearchResults	v2RoomSearchPost(String sessionToken, RoomSearchCriteria query, Integer skip, Integer limit) Search rooms according to the specified criteria.
V3RoomDetail	v3RoomCreatePost(V3RoomAttributes payload, String sessionToken) Create a new chatroom.
V3RoomDetail	v3RoomIdInfoGet(String id, String sessionToken) Get information about a partcular chatroom.
V3RoomDetail	v3RoomIdUpdatePost(String id, V3RoomAttributes payload, String sessionToken) Update the attributes of an existing chatroom.
V3RoomSearchResults	v3RoomSearchPost(String sessionToken, RoomSearchCriteria query, Integer skip, 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()

StreamsApi

public StreamsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1AdminImCreatePost

public Stream v1AdminImCreatePost(UserIdList uidList,
                                  String sessionToken)
                           throws 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:

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

sessionToken - Session authentication token. (required)

Returns:

Stream

Throws:

ApiException - if fails to make API call

v1AdminStreamIdMembershipListGet

public V2MembershipList v1AdminStreamIdMembershipListGet(String id,
                                                         String sessionToken,
                                                         Integer skip,
                                                         Integer limit)
                                                  throws 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:

ApiException - if fails to make API call

v1AdminStreamsListPost

public AdminStreamList v1AdminStreamsListPost(String sessionToken,
                                              Integer skip,
                                              Integer limit,
                                              AdminStreamFilter filter)
                                       throws 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:

AdminStreamList

Throws:

ApiException - if fails to make API call

v1ImCreatePost

public Stream v1ImCreatePost(UserIdList uidList,
                             String sessionToken)
                      throws 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:

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

sessionToken - Session authentication token. (required)

Returns:

Stream

Throws:

ApiException - if fails to make API call

v1RoomCreatePost

public RoomDetail v1RoomCreatePost(RoomCreate payload,
                                   String sessionToken)
                            throws ApiException

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

Parameters:

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

RoomDetail

Throws:

ApiException - if fails to make API call

v1RoomIdInfoGet

public RoomDetail v1RoomIdInfoGet(String id,
                                  String sessionToken)
                           throws ApiException

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

RoomDetail

Throws:

ApiException - if fails to make API call

v1RoomIdSetActivePost

public RoomDetail v1RoomIdSetActivePost(String id,
                                        Boolean active,
                                        String sessionToken)
                                 throws 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:

ApiException - if fails to make API call

v1RoomIdUpdatePost

public RoomDetail v1RoomIdUpdatePost(String id,
                                     RoomAttributes payload,
                                     String sessionToken)
                              throws ApiException

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

RoomDetail

Throws:

ApiException - if fails to make API call

v1StreamsListPost

public StreamList v1StreamsListPost(String sessionToken,
                                    Integer skip,
                                    Integer limit,
                                    StreamFilter filter)
                             throws 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:

StreamList

Throws:

ApiException - if fails to make API call

v1StreamsSidInfoGet

public StreamAttributes v1StreamsSidInfoGet(String sid,
                                            String sessionToken)
                                     throws ApiException

Get information about a partcular stream.

Parameters:

sid - Stream Id (required)

sessionToken - Session authentication token. (required)

Returns:

StreamAttributes

Throws:

ApiException - if fails to make API call

v2RoomCreatePost

public V2RoomDetail v2RoomCreatePost(V2RoomAttributes payload,
                                     String sessionToken)
                              throws ApiException

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

Parameters:

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

V2RoomDetail

Throws:

ApiException - if fails to make API call

v2RoomIdInfoGet

public V2RoomDetail v2RoomIdInfoGet(String id,
                                    String sessionToken)
                             throws ApiException

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

V2RoomDetail

Throws:

ApiException - if fails to make API call

v2RoomIdUpdatePost

public V2RoomDetail v2RoomIdUpdatePost(String id,
                                       V2RoomAttributes payload,
                                       String sessionToken)
                                throws ApiException

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

V2RoomDetail

Throws:

ApiException - if fails to make API call

v2RoomSearchPost

public RoomSearchResults v2RoomSearchPost(String sessionToken,
                                          RoomSearchCriteria query,
                                          Integer skip,
                                          Integer limit)
                                   throws 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:

RoomSearchResults

Throws:

ApiException - if fails to make API call

v3RoomCreatePost

public V3RoomDetail v3RoomCreatePost(V3RoomAttributes payload,
                                     String sessionToken)
                              throws ApiException

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

Parameters:

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

V3RoomDetail

Throws:

ApiException - if fails to make API call

v3RoomIdInfoGet

public V3RoomDetail v3RoomIdInfoGet(String id,
                                    String sessionToken)
                             throws ApiException

Get information about a partcular chatroom.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

V3RoomDetail

Throws:

ApiException - if fails to make API call

v3RoomIdUpdatePost

public V3RoomDetail v3RoomIdUpdatePost(String id,
                                       V3RoomAttributes payload,
                                       String sessionToken)
                                throws ApiException

Update the attributes of an existing chatroom.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

V3RoomDetail

Throws:

ApiException - if fails to make API call

v3RoomSearchPost

public V3RoomSearchResults v3RoomSearchPost(String sessionToken,
                                            RoomSearchCriteria query,
                                            Integer skip,
                                            Integer limit)
                                     throws 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:

ApiException - if fails to make API call