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

Interface OboStreamService

All Known Implementing Classes:

StreamService

@API(status=STABLE)
public interface OboStreamService

Service interface exposing OBO-enabled endpoints to manage streams.

Method Summary

Modifier and Type	Method	Description
void	addMemberToRoom(Long userId, String roomId)	StreamService.addMemberToRoom(Long, String)
V3RoomDetail	create(V3RoomAttributes roomAttributes)	Create a new chatroom.
Stream	create(Long... uids)	StreamService.create(List)
Stream	create(List<Long> uids)	Create a new single or multi party instant message conversation between the caller and specified users.
void	demoteUserToRoomParticipant(Long userId, String roomId)	StreamService.demoteUserToRoomParticipant(Long, String)
V3RoomDetail	getRoomInfo(String roomId)	Get information about a particular room.
V2StreamAttributes	getStream(String streamId)	StreamService.getStream(String)
Stream<StreamAttributes>	listAllStreams(StreamFilter filter)	StreamService.listAllStreams(StreamFilter)
Stream<StreamAttributes>	listAllStreams(StreamFilter filter, StreamPaginationAttribute pagination)	StreamService.listAllStreams(StreamFilter, StreamPaginationAttribute)
List<StreamAttributes>	listStreams(StreamFilter filter)	StreamService.listStreams(StreamFilter)
List<StreamAttributes>	listStreams(StreamFilter filter, PaginationAttribute pagination)	StreamService.listStreams(StreamFilter, PaginationAttribute)
void	promoteUserToRoomOwner(Long userId, String roomId)	StreamService.promoteUserToRoomOwner(Long, String)
void	removeMemberFromRoom(Long userId, String roomId)	StreamService.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.
V2Message	share(String streamId, ShareContent content)	StreamService.share(String, ShareContent)
V3RoomDetail	updateRoom(String roomId, V3RoomAttributes roomAttributes)	Update the attributes of an existing chatroom.

Method Details

create

Stream create(@Nonnull
 Long... uids)

StreamService.create(List)

Parameters:

uids - User ids of the participant

Returns:

The created IM

See Also:

• Create IM or MIM

create

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.

Parameters:

uids - List of user ids of the participants.

Returns:

The created IM or MIM

See Also:

• Create IM or MIM

create

V3RoomDetail create(@Nonnull
 V3RoomAttributes roomAttributes)

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

Parameters:

roomAttributes - Attributes of the created room

Returns:

The created chatroom

See Also:

• Create Room V3

getStream

V2StreamAttributes getStream(@Nonnull
 String streamId)

StreamService.getStream(String)

Parameters:

streamId - The stream id.

Returns:

The information about the stream with the given id.

See Also:

• Stream Info V2

getRoomInfo

V3RoomDetail getRoomInfo(@Nonnull
 String roomId)

Get information about a particular room.

Parameters:

roomId - The room id.

Returns:

The information about the room with the given room id.

See Also:

• Room Info V3

listStreams

List<StreamAttributes> listStreams(@Nullable
 StreamFilter filter)

StreamService.listStreams(StreamFilter)

Parameters:

filter - The stream searching criteria.

Returns:

The list of streams retrieved according to the searching criteria.

See Also:

• List Streams

listStreams

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

StreamService.listStreams(StreamFilter, PaginationAttribute)

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)
Stream<StreamAttributes> listAllStreams(@Nullable
 StreamFilter filter)

StreamService.listAllStreams(StreamFilter)

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)
Stream<StreamAttributes> listAllStreams(@Nullable
 StreamFilter filter,
 @Nonnull
 StreamPaginationAttribute pagination)

StreamService.listAllStreams(StreamFilter, StreamPaginationAttribute)

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

searchRooms

V3RoomSearchResults searchRooms(@Nonnull
 V2RoomSearchCriteria query)

Search rooms according to the specified criteria.

Parameters:

query - The room searching criteria

Returns:

The rooms returned according to the given criteria.

See Also:

• Search Rooms V3

searchRooms

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

Search rooms according to the specified criteria.

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)
Stream<V3RoomDetail> searchAllRooms(@Nonnull
 V2RoomSearchCriteria query)

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

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)
Stream<V3RoomDetail> searchAllRooms(@Nonnull
 V2RoomSearchCriteria query,
 @Nonnull
 StreamPaginationAttribute pagination)

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

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

updateRoom

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

Update the attributes of an existing chatroom.

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

addMemberToRoom

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

StreamService.addMemberToRoom(Long, String)

Parameters:

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

roomId - The room id

See Also:

• Add Member

removeMemberFromRoom

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

StreamService.removeMemberFromRoom(Long, String)

Parameters:

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

roomId - The room id

See Also:

• Remove Member

share

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

StreamService.share(String, ShareContent)

Parameters:

streamId - The stream id.

content - The third-party ShareContent to be shared.

Returns:

Message contains share content

See Also:

• Share

promoteUserToRoomOwner

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

StreamService.promoteUserToRoomOwner(Long, String)

Parameters:

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

roomId - The room id.

See Also:

• Promote Owner

demoteUserToRoomParticipant

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

StreamService.demoteUserToRoomParticipant(Long, String)

Parameters:

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

roomId - The room id.

See Also:

• Demote Owner