Package com.symphony.bdk.core.service.stream

Class StreamService

java.lang.Object

com.symphony.bdk.core.service.stream.StreamService

All Implemented Interfaces:

OboService<OboStreamService>, OboStreamService

@API(status=STABLE)
public class StreamService
extends Object
implements OboStreamService, OboService<OboStreamService>

Service class for managing streams.

This service is used for retrieving information about a particular stream or chatroom, searching streams, listing members, attachments of a particular stream, perform some action related to a stream like:

• Create a IM or MIM
• Create a chatroom
• Activate or Deactivate a chatroom

Constructor Summary

Constructors

Constructor	Description
StreamService(StreamsApi streamsApi, RoomMembershipApi membershipApi, ShareApi shareApi, AuthSession authSession, RetryWithRecoveryBuilder<?> retryBuilder)
StreamService(StreamsApi streamsApi, RoomMembershipApi membershipApi, ShareApi shareApi, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method	Description
void	addMemberToRoom(Long userId, String roomId)	addMemberToRoom(Long, String)
V3RoomDetail	create(V3RoomAttributes roomAttributes)	Create a new chatroom.
Stream	create(Long... uids)	create(List)
Stream	create(List<Long> uids)	Create a new single or multi party instant message conversation between the caller and specified users.
Stream	createInstantMessageAdmin(List<Long> uids)	Create a new single or multi party instant message conversation.
void	demoteUserToRoomParticipant(Long userId, String roomId)	demoteUserToRoomParticipant(Long, String)
V1IMDetail	getInstantMessageInfo(String imId)	Returns information about a particular IM.
V3RoomDetail	getRoomInfo(String roomId)	Get information about a particular room.
V2StreamAttributes	getStream(String streamId)	getStream(String)
Stream<V2MemberInfo>	listAllStreamMembers(String streamId)	List the current members of an existing room and return in a Stream with default chunk size and total size equals 100.
Stream<V2MemberInfo>	listAllStreamMembers(String streamId, StreamPaginationAttribute pagination)	List the current members of an existing room and return in a Stream.
Stream<StreamAttributes>	listAllStreams(StreamFilter filter)	listAllStreams(StreamFilter)
Stream<StreamAttributes>	listAllStreams(StreamFilter filter, StreamPaginationAttribute pagination)	listAllStreams(StreamFilter, StreamPaginationAttribute)
Stream<V2AdminStreamInfo>	listAllStreamsAdmin(V2AdminStreamFilter filter)	Retrieve all the streams across the enterprise and return in a Stream with default chunk size and total size equals 100.
Stream<V2AdminStreamInfo>	listAllStreamsAdmin(V2AdminStreamFilter filter, StreamPaginationAttribute pagination)	Retrieve all the streams across the enterprise and return in a Stream.
List<MemberInfo>	listRoomMembers(String roomId)	Lists the current members of an existing room.
V2MembershipList	listStreamMembers(String streamId)	List the current members of an existing stream.
V2MembershipList	listStreamMembers(String streamId, PaginationAttribute pagination)	List the current members of an existing stream.
List<StreamAttributes>	listStreams(StreamFilter filter)	listStreams(StreamFilter)
List<StreamAttributes>	listStreams(StreamFilter filter, PaginationAttribute pagination)	listStreams(StreamFilter, PaginationAttribute)
V2AdminStreamList	listStreamsAdmin(V2AdminStreamFilter filter)	Retrieve all the streams across the enterprise.
V2AdminStreamList	listStreamsAdmin(V2AdminStreamFilter filter, PaginationAttribute pagination)	Retrieve all the streams across the enterprise.
OboStreamService	obo(AuthSession oboSession)	Returns a new service instance with OBO-enabled endpoints from a given OBO session.
void	promoteUserToRoomOwner(Long userId, String roomId)	promoteUserToRoomOwner(Long, String)
void	removeMemberFromRoom(Long userId, String roomId)	removeMemberFromRoom(Long, String)
Stream<V3RoomDetail>	searchAllRooms(V2RoomSearchCriteria query)	Search rooms and return in a Stream according to the specified criteria.
Stream<V3RoomDetail>	searchAllRooms(V2RoomSearchCriteria query, StreamPaginationAttribute pagination)	Search rooms and return in a Stream according to the specified criteria.
V3RoomSearchResults	searchRooms(V2RoomSearchCriteria query)	Search rooms according to the specified criteria.
V3RoomSearchResults	searchRooms(V2RoomSearchCriteria query, PaginationAttribute pagination)	Search rooms according to the specified criteria.
RoomDetail	setRoomActive(String roomId, Boolean active)	Deactivate or reactivate a chatroom.
RoomDetail	setRoomActiveAdmin(String streamId, Boolean active)	Deactivate or reactivate a chatroom via AC Portal.
V2Message	share(String streamId, ShareContent content)	share(String, ShareContent)
V1IMDetail	updateInstantMessage(String imId, V1IMAttributes imAttributes)	Updates attributes on an existing IM
V3RoomDetail	updateRoom(String roomId, V3RoomAttributes roomAttributes)	Update the attributes of an existing chatroom.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.symphony.bdk.core.service.OboService

checkAuthSession

Constructor Details

StreamService

public StreamService(StreamsApi streamsApi,
 RoomMembershipApi membershipApi,
 ShareApi shareApi,
 AuthSession authSession,
 RetryWithRecoveryBuilder<?> retryBuilder)

StreamService

public StreamService(StreamsApi streamsApi,
 RoomMembershipApi membershipApi,
 ShareApi shareApi,
 RetryWithRecoveryBuilder<?> retryBuilder)

Method Details

obo

public OboStreamService obo(AuthSession oboSession)

Returns a new service instance with OBO-enabled endpoints from a given OBO session.

Specified by:

obo in interface OboService<OboStreamService>

Parameters:

oboSession - the OBO session

Returns:

the instance of the service class with OBO-enabled endpoints

getStream

public V2StreamAttributes getStream(@Nonnull
 String streamId)

getStream(String)

Specified by:

getStream in interface OboStreamService

Parameters:

streamId - The stream id.

Returns:

The information about the stream with the given id.

See Also:

• Stream Info V2

listStreams

public List<StreamAttributes> listStreams(@Nullable
 StreamFilter filter)

listStreams(StreamFilter)

Specified by:

listStreams in interface OboStreamService

Parameters:

filter - The stream searching criteria.

Returns:

The list of streams retrieved according to the searching criteria.

See Also:

• List Streams

listStreams

public List<StreamAttributes> listStreams(@Nullable
 StreamFilter filter,
 @Nonnull
 PaginationAttribute pagination)

listStreams(StreamFilter, PaginationAttribute)

Specified by:

listStreams in interface OboStreamService

Parameters:

filter - The stream searching criteria.

pagination - The skip and limit for pagination.

Returns:

The list of streams retrieved according to the searching criteria.

See Also:

• List Streams

listAllStreams

@API(status=EXPERIMENTAL)
public Stream<StreamAttributes> listAllStreams(@Nullable
 StreamFilter filter)

listAllStreams(StreamFilter)

Specified by:

listAllStreams in interface OboStreamService

Parameters:

filter - The stream searching criteria.

Returns:

a Stream of matching streams according to the searching criteria.

See Also:

• List Streams

listAllStreams

@API(status=EXPERIMENTAL)
public Stream<StreamAttributes> listAllStreams(@Nullable
 StreamFilter filter,
 @Nonnull
 StreamPaginationAttribute pagination)

listAllStreams(StreamFilter, StreamPaginationAttribute)

Specified by:

listAllStreams in interface OboStreamService

Parameters:

filter - The stream searching criteria.

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream of matching streams according to the searching criteria.

See Also:

• List Streams

addMemberToRoom

public void addMemberToRoom(@Nonnull
 Long userId,
 @Nonnull
 String roomId)

addMemberToRoom(Long, String)

Specified by:

addMemberToRoom in interface OboStreamService

Parameters:

userId - The id of the user to be added to the given room

roomId - The room id

See Also:

• Add Member

removeMemberFromRoom

public void removeMemberFromRoom(@Nonnull
 Long userId,
 @Nonnull
 String roomId)

removeMemberFromRoom(Long, String)

Specified by:

removeMemberFromRoom in interface OboStreamService

Parameters:

userId - The id of the user to be removed from the given room

roomId - The room id

See Also:

• Remove Member

share

public V2Message share(@Nonnull
 String streamId,
 @Nonnull
 ShareContent content)

share(String, ShareContent)

Specified by:

share in interface OboStreamService

Parameters:

streamId - The stream id.

content - The third-party ShareContent to be shared.

Returns:

Message contains share content

See Also:

• Share

promoteUserToRoomOwner

public void promoteUserToRoomOwner(@Nonnull
 Long userId,
 @Nonnull
 String roomId)

promoteUserToRoomOwner(Long, String)

Specified by:

promoteUserToRoomOwner in interface OboStreamService

Parameters:

userId - The id of the user to be promoted to room owner.

roomId - The room id.

See Also:

• Promote Owner

demoteUserToRoomParticipant

public void demoteUserToRoomParticipant(@Nonnull
 Long userId,
 @Nonnull
 String roomId)

demoteUserToRoomParticipant(Long, String)

Specified by:

demoteUserToRoomParticipant in interface OboStreamService

Parameters:

userId - The id of the user to be demoted to room participant.

roomId - The room id.

See Also:

• Demote Owner

create

public Stream create(@Nonnull
 Long... uids)

create(List)

Specified by:

create in interface OboStreamService

Parameters:

uids - User ids of the participant

Returns:

The created IM

See Also:

• Create IM or MIM

create

public Stream create(@Nonnull
 List<Long> uids)

Create a new single or multi party instant message conversation between the caller and specified users.

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.

If the given list of user ids contains only one id, an IM will be created, otherwise, a MIM will be created.

Specified by:

create in interface OboStreamService

Parameters:

uids - List of user ids of the participants.

Returns:

The created IM or MIM

See Also:

• Create IM or MIM

create

public V3RoomDetail create(@Nonnull
 V3RoomAttributes roomAttributes)

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

Specified by:

create in interface OboStreamService

Parameters:

roomAttributes - Attributes of the created room

Returns:

The created chatroom

See Also:

• Create Room V3

updateRoom

public V3RoomDetail updateRoom(@Nonnull
 String roomId,
 @Nonnull
 V3RoomAttributes roomAttributes)

Update the attributes of an existing chatroom.

Specified by:

updateRoom in interface OboStreamService

Parameters:

roomId - The id of the room to be updated

roomAttributes - The attributes to be updated to the room

Returns:

The information of the room after being updated.

See Also:

• Update Room V3

getRoomInfo

public V3RoomDetail getRoomInfo(@Nonnull
 String roomId)

Get information about a particular room.

Specified by:

getRoomInfo in interface OboStreamService

Parameters:

roomId - The room id.

Returns:

The information about the room with the given room id.

See Also:

• Room Info V3

searchRooms

public V3RoomSearchResults searchRooms(@Nonnull
 V2RoomSearchCriteria query)

Search rooms according to the specified criteria.

Specified by:

searchRooms in interface OboStreamService

Parameters:

query - The room searching criteria

Returns:

The rooms returned according to the given criteria.

See Also:

• Search Rooms V3

searchRooms

public V3RoomSearchResults searchRooms(@Nonnull
 V2RoomSearchCriteria query,
 @Nonnull
 PaginationAttribute pagination)

Search rooms according to the specified criteria.

Specified by:

searchRooms in interface OboStreamService

Parameters:

query - The room searching criteria.

pagination - The skip and limit for pagination.

Returns:

The rooms returned according to the given criteria.

See Also:

• Search Rooms V3

searchAllRooms

@API(status=EXPERIMENTAL)
public Stream<V3RoomDetail> searchAllRooms(@Nonnull
 V2RoomSearchCriteria query)

Search rooms and return in a Stream according to the specified criteria.

Specified by:

searchAllRooms in interface OboStreamService

Parameters:

query - The room searching criteria.

Returns:

A Stream of rooms returned according to the given criteria.

See Also:

• Search Rooms V3

searchAllRooms

@API(status=EXPERIMENTAL)
public Stream<V3RoomDetail> searchAllRooms(@Nonnull
 V2RoomSearchCriteria query,
 @Nonnull
 StreamPaginationAttribute pagination)

Search rooms and return in a Stream according to the specified criteria.

Specified by:

searchAllRooms in interface OboStreamService

Parameters:

query - The room searching criteria.

pagination - The chunkSize and totalSize for stream pagination.

Returns:

A Stream of rooms returned according to the given criteria.

See Also:

• Search Rooms V3

setRoomActive

public RoomDetail setRoomActive(@Nonnull
 String roomId,
 @Nonnull
 Boolean active)

Deactivate or reactivate a chatroom. At the creation, the chatroom is activated by default.

Parameters:

roomId - The room id

active - Deactivate or activate

Returns:

The information of the room after being deactivated or reactivated.

See Also:

• De/Reactivate Room

createInstantMessageAdmin

public Stream createInstantMessageAdmin(@Nonnull
 List<Long> uids)

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:

uids - List of user IDs of participants. At least two user IDs must be provided

Returns:

The created IM or MIM

See Also:

• Create IM or MIM Non-inclusive

updateInstantMessage

public V1IMDetail updateInstantMessage(@Nonnull
 String imId,
 @Nonnull
 V1IMAttributes imAttributes)

Updates attributes on an existing IM

Parameters:

imId - The id or the IM to be updated

imAttributes - The attributes to be updated in the IM

Returns:

IM information after the update

See Also:

• Update IM

getInstantMessageInfo

public V1IMDetail getInstantMessageInfo(@Nonnull
 String imId)

Returns information about a particular IM.

Parameters:

imId - The id of the IM.

Returns:

The information about the IM with the given id

See Also:

• IM Info

setRoomActiveAdmin

public RoomDetail setRoomActiveAdmin(@Nonnull
 String streamId,
 @Nonnull
 Boolean active)

Deactivate or reactivate a chatroom via AC Portal.

Parameters:

streamId - The stream id

active - Deactivate or activate

Returns:

The information of the room after being deactivated or reactivated.

listStreamsAdmin

public V2AdminStreamList listStreamsAdmin(@Nullable
 V2AdminStreamFilter filter)

Retrieve all the streams across the enterprise.

Parameters:

filter - The stream searching filter

Returns:

List of streams returned according the given filter.

See Also:

• List Streams for Enterprise V2

listStreamsAdmin

public V2AdminStreamList listStreamsAdmin(@Nullable
 V2AdminStreamFilter filter,
 @Nonnull
 PaginationAttribute pagination)

Retrieve all the streams across the enterprise.

Parameters:

filter - The stream searching filter

pagination - The skip and limit for pagination.

Returns:

List of streams returned according the given filter.

See Also:

• List Streams for Enterprise V2

listAllStreamsAdmin

@API(status=EXPERIMENTAL)
public Stream<V2AdminStreamInfo> listAllStreamsAdmin(@Nullable
 V2AdminStreamFilter filter)

Retrieve all the streams across the enterprise and return in a Stream with default chunk size and total size equals 100.

Parameters:

filter - The stream searching filter

Returns:

List of streams returned according the given filter.

See Also:

• List Streams for Enterprise V2

listAllStreamsAdmin

@API(status=EXPERIMENTAL)
public Stream<V2AdminStreamInfo> listAllStreamsAdmin(@Nullable
 V2AdminStreamFilter filter,
 @Nonnull
 StreamPaginationAttribute pagination)

Retrieve all the streams across the enterprise and return in a Stream.

Parameters:

filter - The stream searching filter

pagination - The chunkSize and totalSize for stream pagination.

Returns:

A Stream of streams returned according the given filter.

See Also:

• List Streams for Enterprise V2

listStreamMembers

public V2MembershipList listStreamMembers(@Nonnull
 String streamId)

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

Parameters:

streamId - The stream id

Returns:

List of member in the stream with the given stream id.

See Also:

• Stream Members

listStreamMembers

public V2MembershipList listStreamMembers(@Nonnull
 String streamId,
 @Nonnull
 PaginationAttribute pagination)

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

Parameters:

streamId - The stream id

pagination - The skip and limit for pagination.

Returns:

List of member in the stream with the given stream id.

See Also:

• Stream Members

listAllStreamMembers

@API(status=EXPERIMENTAL)
public Stream<V2MemberInfo> listAllStreamMembers(@Nonnull
 String streamId)

List the current members of an existing room and return in a Stream with default chunk size and total size equals 100. The stream can be of type IM, MIM, or ROOM.

Parameters:

streamId - The stream id

Returns:

A Stream of members in the stream with the given stream id.

See Also:

• Stream Members

listAllStreamMembers

@API(status=EXPERIMENTAL)
public Stream<V2MemberInfo> listAllStreamMembers(@Nonnull
 String streamId,
 @Nonnull
 StreamPaginationAttribute pagination)

List the current members of an existing room and return in a Stream. The stream can be of type IM, MIM, or ROOM.

Parameters:

streamId - The stream id

pagination - The chunkSize and totalSize for stream pagination with default value equal 100.

Returns:

A Stream of members in the stream with the given stream id.

See Also:

• Stream Members

listRoomMembers

public List<MemberInfo> listRoomMembers(@Nonnull
 String roomId)

Lists the current members of an existing room.

Parameters:

roomId - The room stream id

Returns:

List of members in the room with the given room id.

See Also:

• Room Members