Package com.github.twitch4j.pubsub.events

Class PubSubAuthRevokeEvent

java.lang.Object

com.github.philippheuer.events4j.core.domain.Event

com.github.twitch4j.common.events.TwitchEvent

com.github.twitch4j.pubsub.events.PubSubAuthRevokeEvent

All Implemented Interfaces:

com.github.philippheuer.events4j.api.domain.IEvent

public final class PubSubAuthRevokeEvent
extends TwitchEvent

Fired when a user access token had outstanding PubSub subscriptions, but was revoked.

An authorization can be revoked at any time for a number of reasons, such a user disconnecting from an app through Connections Settings.

Topics associated with the authorization will automatically be unlistened to.

Constructor Summary

Constructors

Constructor	Description
PubSubAuthRevokeEvent(ITwitchPubSub socket, @NotNull Map<@NotNull String,@Nullable PubSubRequest> revokedListensByTopic)	Creates a new PubSubAuthRevokeEvent instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NotNull Map<@NotNull String,@Nullable PubSubRequest>	getRevokedListensByTopic()	Mappings of revoked topic names to the associated PubSubRequest (LISTEN).
ITwitchPubSub	getSocket()	The PubSub websocket that was subscribed to these revoked topics.
@NotNull Collection<String>	getTopicNames()
int	hashCode()
String	toString()

Methods inherited from class com.github.philippheuer.events4j.core.domain.Event

getEventId, getFiredAt, getFiredAtInstant, getServiceMediator, setEventId, setFiredAt, setFiredAtInstant, setServiceMediator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PubSubAuthRevokeEvent

public PubSubAuthRevokeEvent(ITwitchPubSub socket,
 @NotNull
 @NotNull Map<@NotNull String,@Nullable PubSubRequest> revokedListensByTopic)

Creates a new PubSubAuthRevokeEvent instance.

Parameters:

socket - The PubSub websocket that was subscribed to these revoked topics.

revokedListensByTopic - Mappings of revoked topic names to the associated PubSubRequest (LISTEN).

Warning: Values can be null if you manually call ITwitchPubSub.listenOnTopic(PubSubRequest) or ITwitchPubSub.listenOnTopic(PubSubType, OAuth2Credential, Collection) with requests that contain more than one topic in a single PubSubType.LISTEN.

Method Details

getTopicNames

@NotNull
public @NotNull Collection<String> getTopicNames()

Returns:

the topics that were revoked (including the user id's)

getSocket

public ITwitchPubSub getSocket()

The PubSub websocket that was subscribed to these revoked topics.

getRevokedListensByTopic

@NotNull
public @NotNull Map<@NotNull String,@Nullable PubSubRequest> getRevokedListensByTopic()

Mappings of revoked topic names to the associated PubSubRequest (LISTEN).

Warning: Values can be null if you manually call ITwitchPubSub.listenOnTopic(PubSubRequest) or ITwitchPubSub.listenOnTopic(PubSubType, OAuth2Credential, Collection) with requests that contain more than one topic in a single PubSubType.LISTEN.

toString

public String toString()

Overrides:

toString in class TwitchEvent

equals

public boolean equals(Object o)

Overrides:

equals in class TwitchEvent

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class TwitchEvent

hashCode

public int hashCode()

Overrides:

hashCode in class TwitchEvent