Package live.crowdcontrol.cc4j.websocket.payload

Class SubscriptionResultPayload

java.lang.Object

live.crowdcontrol.cc4j.websocket.payload.SubscriptionResultPayload

public class SubscriptionResultPayload
extends Object

Denotes information about subscribed topics, namely which requested topics were successfully subscribed to. Topics may be rejected if you lack authentication.

Constructor Summary

Constructors

Constructor	Description
SubscriptionResultPayload(@NotNull Set<@NotNull String> success, @NotNull Set<@NotNull String> failure)

Method Summary

Modifier and Type	Method	Description
@NotNull Set<@NotNull String>	getFailure()	Gets the set of topics that could not be subscribed to.
@NotNull Set<@NotNull String>	getSuccess()	Gets the set of successfully subscribed topics.

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionResultPayload

public SubscriptionResultPayload(@NotNull
 @NotNull Set<@NotNull String> success,
 @NotNull
 @NotNull Set<@NotNull String> failure)

Method Details

getSuccess

@NotNull
public @NotNull Set<@NotNull String> getSuccess()

Gets the set of successfully subscribed topics. It is immutable.

Returns:

subscribed topics

getFailure

@NotNull
public @NotNull Set<@NotNull String> getFailure()

Gets the set of topics that could not be subscribed to. This usually indicates a permission failure. It is immutable.

Returns:

not subscribed topics