com.symphony.bdk.core.service.signal

Class SignalService

java.lang.Object

com.symphony.bdk.core.service.signal.SignalService

All Implemented Interfaces:

OboService<OboSignalService>, OboSignalService

@API(status=STABLE)
public class SignalService
extends java.lang.Object
implements OboSignalService, OboService<OboSignalService>

Service class for managing signal information.

This service is used for listing signals related to the user, get information of a specified signal or perform some actions related to the signal like:

• Create a signal
• Update a signal
• Delete a signal
• Subscribe or unsubscribe a signal

Constructor Summary

Constructors

Constructor and Description
SignalService(SignalsApi signalsApi, AuthSession authSession, RetryWithRecoveryBuilder<?> retryBuilder)
SignalService(SignalsApi signalsApi, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method and Description
Signal	createSignal(BaseSignal signal) Create a new signal.
void	deleteSignal(java.lang.String id) Delete an existing signal.
Signal	getSignal(java.lang.String id) Gets details about the specified signal.
java.util.stream.Stream<Signal>	listAllSignals() Lists paginated stream of signals on behalf of the user with the default chunkSize and totalSize equal 100.
java.util.stream.Stream<Signal>	listAllSignals(StreamPaginationAttribute pagination) Lists paginated stream of signals on behalf of the user.
java.util.stream.Stream<ChannelSubscriber>	listAllSubscribers(java.lang.String id) Get the paginated stream of subscribers for a specified signal with the default chunkSize and totalSize equal to 100.
java.util.stream.Stream<ChannelSubscriber>	listAllSubscribers(java.lang.String id, StreamPaginationAttribute pagination) Get the paginated stream of subscribers for a specified signal.
java.util.List<Signal>	listSignals() Lists signals on behalf of the user with default limit equal 50.
java.util.List<Signal>	listSignals(PaginationAttribute pagination) Lists signals on behalf of the user.
java.util.List<ChannelSubscriber>	listSubscribers(java.lang.String id) Get the subscribers for a specified signal with default limit equal to 100.
java.util.List<ChannelSubscriber>	listSubscribers(java.lang.String id, PaginationAttribute pagination) Get the subscribers for a specified signal.
OboSignalService	obo(AuthSession oboSession) Returns a new service instance with OBO-enabled endpoints from a given OBO session.
ChannelSubscriptionResponse	subscribeUsersToSignal(java.lang.String id, java.lang.Boolean pushed, java.util.List<java.lang.Long> userIds) Subscribe a list of users to a signal.
ChannelSubscriptionResponse	unsubscribeUsersFromSignal(java.lang.String id, java.util.List<java.lang.Long> userIds) Unsubscribe a list of users from a signal.
Signal	updateSignal(java.lang.String id, BaseSignal signal) Update an existing signal.

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 Detail

SignalService

public SignalService(SignalsApi signalsApi,
                     AuthSession authSession,
                     RetryWithRecoveryBuilder<?> retryBuilder)

SignalService

public SignalService(SignalsApi signalsApi,
                     RetryWithRecoveryBuilder<?> retryBuilder)

Method Detail

obo

public OboSignalService obo(AuthSession oboSession)

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

Specified by:

obo in interface OboService<OboSignalService>

Parameters:

oboSession - the OBO session

Returns:

the instance of the service class with OBO-enabled endpoints

listSignals

public java.util.List<Signal> listSignals(@Nonnull
                                          PaginationAttribute pagination)

Lists signals on behalf of the user. listSignals(PaginationAttribute)

Specified by:

listSignals in interface OboSignalService

Parameters:

pagination - The skip and limit for pagination.

Returns:

List of signals that the user has created and public signals to which they have subscribed.

See Also:

List Signals

listSignals

public java.util.List<Signal> listSignals()

Lists signals on behalf of the user with default limit equal 50. listSignals()

Specified by:

listSignals in interface OboSignalService

Returns:

List of signals that the user has created and public signals to which they have subscribed.

See Also:

List Signals

listAllSignals

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<Signal> listAllSignals(@Nonnull
                                                                                StreamPaginationAttribute pagination)

Lists paginated stream of signals on behalf of the user. listAllSignals(StreamPaginationAttribute)

Specified by:

listAllSignals in interface OboSignalService

Parameters:

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream containing the signals.

See Also:

List Signals

listAllSignals

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<Signal> listAllSignals()

Lists paginated stream of signals on behalf of the user with the default chunkSize and totalSize equal 100. listAllSignals()

Specified by:

listAllSignals in interface OboSignalService

Returns:

a Stream containing the signals.

See Also:

List Signals

getSignal

public Signal getSignal(@Nonnull
                        java.lang.String id)

Gets details about the specified signal. getSignal(String)

Specified by:

getSignal in interface OboSignalService

Parameters:

id - The id of the signal.

Returns:

Details of the specified signal.

See Also:

Get Signal

createSignal

public Signal createSignal(@Nonnull
                           BaseSignal signal)

Create a new signal. createSignal(BaseSignal)

Specified by:

createSignal in interface OboSignalService

Parameters:

signal - A signal object to be created.

Returns:

A new created signal object.

See Also:

Create Signal

updateSignal

public Signal updateSignal(@Nonnull
                           java.lang.String id,
                           @Nonnull
                           BaseSignal signal)

Update an existing signal. updateSignal(String, BaseSignal)

Specified by:

updateSignal in interface OboSignalService

Parameters:

id - The id of the signal to be updated.

signal - The signal object to be updated.

Returns:

The updated signal.

See Also:

Update Signal

deleteSignal

public void deleteSignal(@Nonnull
                         java.lang.String id)

Delete an existing signal. deleteSignal(String)

Specified by:

deleteSignal in interface OboSignalService

Parameters:

id - The id of the signal to be deleted.

See Also:

Delete Signal

subscribeUsersToSignal

public ChannelSubscriptionResponse subscribeUsersToSignal(@Nonnull
                                                          java.lang.String id,
                                                          @Nullable
                                                          java.lang.Boolean pushed,
                                                          @Nullable
                                                          java.util.List<java.lang.Long> userIds)

Subscribe a list of users to a signal. subscribeUsersToSignal(String, Boolean, List)

Specified by:

subscribeUsersToSignal in interface OboSignalService

Parameters:

id - The id of the signal to be subscribed.

pushed - Prevents the user from unsubscribing from the Signal (only for bulk subscriptions). Requires the canManageSignalSubscription entitlement.

userIds - List of user ids to subscribe to the signal

Returns:

The subscription information.

See Also:

Subscribe Signal

unsubscribeUsersFromSignal

public ChannelSubscriptionResponse unsubscribeUsersFromSignal(@Nonnull
                                                              java.lang.String id,
                                                              @Nullable
                                                              java.util.List<java.lang.Long> userIds)

Unsubscribe a list of users from a signal. unsubscribeUsersFromSignal(String, List)

Specified by:

unsubscribeUsersFromSignal in interface OboSignalService

Parameters:

id - The id of the signal to be unsubscribed.

userIds - The list of user ids to unsubscribe from the signal.

Returns:

The unsubscription information.

See Also:

Unsubscribe Signal

listSubscribers

public java.util.List<ChannelSubscriber> listSubscribers(@Nonnull
                                                         java.lang.String id,
                                                         @Nonnull
                                                         PaginationAttribute pagination)

Get the subscribers for a specified signal. listSubscribers(String, PaginationAttribute)

Specified by:

listSubscribers in interface OboSignalService

Parameters:

id - The id of the specified signal.

pagination - The skip and limit for pagination.

Returns:

List of subscribers of the signal.

See Also:

Subscribers

listSubscribers

public java.util.List<ChannelSubscriber> listSubscribers(@Nonnull
                                                         java.lang.String id)

Get the subscribers for a specified signal with default limit equal to 100. listSubscribers(String)

Specified by:

listSubscribers in interface OboSignalService

Parameters:

id - The id of the specified signal.

Returns:

List of subscribers of the signal.

See Also:

Subscribers

listAllSubscribers

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<ChannelSubscriber> listAllSubscribers(@Nonnull
                                                                                               java.lang.String id,
                                                                                               @Nonnull
                                                                                               StreamPaginationAttribute pagination)

Get the paginated stream of subscribers for a specified signal. listAllSubscribers(String, StreamPaginationAttribute)

Specified by:

listAllSubscribers in interface OboSignalService

Parameters:

id - The id of the specified signal.

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream containing the subscribers.

See Also:

Subscribers

listAllSubscribers

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<ChannelSubscriber> listAllSubscribers(@Nonnull
                                                                                               java.lang.String id)

Get the paginated stream of subscribers for a specified signal with the default chunkSize and totalSize equal to 100. listAllSubscribers(String)

Specified by:

listAllSubscribers in interface OboSignalService

Parameters:

id - The id of the specified signal.

Returns:

a Stream containing the subscribers.

See Also:

Subscribers