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 and Description
void	addMemberToRoom(java.lang.Long userId, java.lang.String roomId) StreamService.addMemberToRoom(Long, String)
void	demoteUserToRoomParticipant(java.lang.Long userId, java.lang.String roomId) StreamService.demoteUserToRoomParticipant(Long, String)
V2StreamAttributes	getStream(java.lang.String streamId) StreamService.getStream(String)
java.util.stream.Stream<StreamAttributes>	listAllStreams(StreamFilter filter) StreamService.listAllStreams(StreamFilter)
java.util.stream.Stream<StreamAttributes>	listAllStreams(StreamFilter filter, StreamPaginationAttribute pagination) StreamService.listAllStreams(StreamFilter, StreamPaginationAttribute)
java.util.List<StreamAttributes>	listStreams(StreamFilter filter) StreamService.listStreams(StreamFilter)
java.util.List<StreamAttributes>	listStreams(StreamFilter filter, PaginationAttribute pagination) StreamService.listStreams(StreamFilter, PaginationAttribute)
void	promoteUserToRoomOwner(java.lang.Long userId, java.lang.String roomId) StreamService.promoteUserToRoomOwner(Long, String)
void	removeMemberFromRoom(java.lang.Long userId, java.lang.String roomId) StreamService.removeMemberFromRoom(Long, String)
V2Message	share(java.lang.String streamId, ShareContent content) StreamService.share(String, ShareContent)

Method Detail

getStream

V2StreamAttributes getStream(@Nonnull
                             java.lang.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

listStreams

java.util.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

java.util.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)
java.util.stream.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)
java.util.stream.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

addMemberToRoom

void addMemberToRoom(@Nonnull
                     java.lang.Long userId,
                     @Nonnull
                     java.lang.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
                          java.lang.Long userId,
                          @Nonnull
                          java.lang.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
                java.lang.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
                            java.lang.Long userId,
                            @Nonnull
                            java.lang.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
                                 java.lang.Long userId,
                                 @Nonnull
                                 java.lang.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