Interface OboSignalService
- All Known Implementing Classes:
SignalService
@API(status=STABLE)
public interface OboSignalService
Service interface exposing OBO-enabled endpoints to manage signals information.
-
Method Summary
Modifier and TypeMethodDescriptioncreateSignal
(BaseSignal signal) Create a new signal.void
deleteSignal
(String id) Delete an existing signal.Gets details about the specified signal.Lists paginated stream of signals on behalf of the user with the default chunkSize and totalSize equal 100.listAllSignals
(StreamPaginationAttribute pagination) Lists paginated stream of signals on behalf of the user.Get the paginated stream of subscribers for a specified signal with the default chunkSize and totalSize equal to 100.listAllSubscribers
(String id, StreamPaginationAttribute pagination) Get the paginated stream of subscribers for a specified signal.Lists signals on behalf of the user with default limit equal 50.listSignals
(PaginationAttribute pagination) Lists signals on behalf of the user.Get the subscribers for a specified signal with default limit equal to 100.listSubscribers
(String id, PaginationAttribute pagination) Get the subscribers for a specified signal.subscribeUsersToSignal
(String id, Boolean pushed, List<Long> userIds) Subscribe a list of users to a signal.unsubscribeUsersFromSignal
(String id, List<Long> userIds) Unsubscribe a list of users from a signal.updateSignal
(String id, BaseSignal signal) Update an existing signal.
-
Method Details
-
listSignals
Lists signals on behalf of the user.SignalService.listSignals(PaginationAttribute)
- 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:
-
listSignals
Lists signals on behalf of the user with default limit equal 50.SignalService.listSignals()
- Returns:
- List of signals that the user has created and public signals to which they have subscribed.
- See Also:
-
listAllSignals
@API(status=EXPERIMENTAL) Stream<Signal> listAllSignals(@Nonnull StreamPaginationAttribute pagination) Lists paginated stream of signals on behalf of the user.SignalService.listAllSignals(StreamPaginationAttribute)
- Parameters:
pagination
- The chunkSize and totalSize for pagination.- Returns:
- a
Stream
containing the signals. - See Also:
-
listAllSignals
Lists paginated stream of signals on behalf of the user with the default chunkSize and totalSize equal 100.SignalService.listAllSignals()
- Returns:
- a
Stream
containing the signals. - See Also:
-
getSignal
Gets details about the specified signal.SignalService.getSignal(String)
- Parameters:
id
- The id of the signal.- Returns:
- Details of the specified signal.
- See Also:
-
createSignal
Create a new signal.SignalService.createSignal(BaseSignal)
- Parameters:
signal
- A signal object to be created.- Returns:
- A new created signal object.
- See Also:
-
updateSignal
Update an existing signal.SignalService.updateSignal(String, BaseSignal)
- Parameters:
id
- The id of the signal to be updated.signal
- The signal object to be updated.- Returns:
- The updated signal.
- See Also:
-
deleteSignal
Delete an existing signal.SignalService.deleteSignal(String)
- Parameters:
id
- The id of the signal to be deleted.- See Also:
-
subscribeUsersToSignal
ChannelSubscriptionResponse subscribeUsersToSignal(@Nonnull String id, @Nullable Boolean pushed, @Nullable List<Long> userIds) Subscribe a list of users to a signal.SignalService.subscribeUsersToSignal(String, Boolean, List)
- 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:
-
unsubscribeUsersFromSignal
ChannelSubscriptionResponse unsubscribeUsersFromSignal(@Nonnull String id, @Nullable List<Long> userIds) Unsubscribe a list of users from a signal.SignalService.unsubscribeUsersFromSignal(String, List)
- 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:
-
listSubscribers
List<ChannelSubscriber> listSubscribers(@Nonnull String id, @Nonnull PaginationAttribute pagination) Get the subscribers for a specified signal.SignalService.listSubscribers(String, PaginationAttribute)
- Parameters:
id
- The id of the specified signal.pagination
- The skip and limit for pagination.- Returns:
- List of subscribers of the signal.
- See Also:
-
listSubscribers
Get the subscribers for a specified signal with default limit equal to 100.SignalService.listSubscribers(String)
- Parameters:
id
- The id of the specified signal.- Returns:
- List of subscribers of the signal.
- See Also:
-
listAllSubscribers
@API(status=EXPERIMENTAL) Stream<ChannelSubscriber> listAllSubscribers(@Nonnull String id, @Nonnull StreamPaginationAttribute pagination) Get the paginated stream of subscribers for a specified signal.SignalService.listAllSubscribers(String, StreamPaginationAttribute)
- Parameters:
id
- The id of the specified signal.pagination
- The chunkSize and totalSize for pagination.- Returns:
- a
Stream
containing the subscribers. - See Also:
-
listAllSubscribers
Get the paginated stream of subscribers for a specified signal with the default chunkSize and totalSize equal to 100.SignalService.listAllSubscribers(String)
- Parameters:
id
- The id of the specified signal.- Returns:
- a
Stream
containing the subscribers. - See Also:
-