Package com.github.twitch4j.helix.domain

Class SendPubSubMessageInput

java.lang.Object

com.github.twitch4j.helix.domain.SendPubSubMessageInput

public class SendPubSubMessageInput
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendPubSubMessageInput.SendPubSubMessageInputBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROADCAST_TARGET	Target a specific public channel.
static final String	GLOBAL_TARGET	Target all channels that have the extension active.
static final String	WHISPER_TARGET_PREFIX	Target a user via private message.

Constructor Summary

Constructors

Constructor	Description
SendPubSubMessageInput()
SendPubSubMessageInput(List<String> targets, @Nullable String broadcasterId, boolean globalBroadcast, String message)	Creates a new SendPubSubMessageInput instance.

Method Summary

Modifier and Type	Method	Description
static SendPubSubMessageInput.SendPubSubMessageInputBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable String	getBroadcasterId()	ID of the broadcaster receiving the payload.
String	getMessage()	String-encoded JSON message to be sent.
List<String>	getTargets()	Strings for valid PubSub targets.
int	hashCode()
boolean	isGlobalBroadcast()	Indicates if the message should be sent to all channels where your Extension is active.
SendPubSubMessageInput.SendPubSubMessageInputBuilder	toBuilder()
String	toString()
boolean	validate()
SendPubSubMessageInput	withBroadcasterId(@Nullable String broadcasterId)	ID of the broadcaster receiving the payload.
SendPubSubMessageInput	withGlobalBroadcast(boolean globalBroadcast)	Indicates if the message should be sent to all channels where your Extension is active.
SendPubSubMessageInput	withMessage(String message)	String-encoded JSON message to be sent.
SendPubSubMessageInput	withTargets(List<String> targets)	Strings for valid PubSub targets.

Methods inherited from class java.lang.Object

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

Field Details

BROADCAST_TARGET

public static final String BROADCAST_TARGET

Target a specific public channel.

See Also:

• Constant Field Values

GLOBAL_TARGET

public static final String GLOBAL_TARGET

Target all channels that have the extension active.

See Also:

• Constant Field Values

WHISPER_TARGET_PREFIX

public static final String WHISPER_TARGET_PREFIX

Target a user via private message.

See Also:

• Constant Field Values

Constructor Details

SendPubSubMessageInput

public SendPubSubMessageInput()

SendPubSubMessageInput

public SendPubSubMessageInput(List<String> targets,
 @Nullable
 @Nullable String broadcasterId,
 boolean globalBroadcast,
 String message)

Creates a new SendPubSubMessageInput instance.

Parameters:

targets - Strings for valid PubSub targets. Valid values: "broadcast", "global", "whisper-<user-id>"

broadcasterId - ID of the broadcaster receiving the payload. This is not required if is_global_broadcast is set to true.

globalBroadcast - Indicates if the message should be sent to all channels where your Extension is active.

Default: false.

message - String-encoded JSON message to be sent.

Must not exceed 5 KB in size.

Method Details

validate

public boolean validate()

Returns:

whether the constructed input complies with twitch requirements.

builder

public static SendPubSubMessageInput.SendPubSubMessageInputBuilder builder()

toBuilder

public SendPubSubMessageInput.SendPubSubMessageInputBuilder toBuilder()

withTargets

public SendPubSubMessageInput withTargets(List<String> targets)

Strings for valid PubSub targets. Valid values: "broadcast", "global", "whisper-<user-id>"

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withBroadcasterId

public SendPubSubMessageInput withBroadcasterId(@Nullable
 @Nullable String broadcasterId)

ID of the broadcaster receiving the payload. This is not required if is_global_broadcast is set to true.

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withGlobalBroadcast

public SendPubSubMessageInput withGlobalBroadcast(boolean globalBroadcast)

Indicates if the message should be sent to all channels where your Extension is active.

Default: false.

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withMessage

public SendPubSubMessageInput withMessage(String message)

String-encoded JSON message to be sent.

Must not exceed 5 KB in size.

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

getTargets

public List<String> getTargets()

Strings for valid PubSub targets. Valid values: "broadcast", "global", "whisper-<user-id>"

getBroadcasterId

@Nullable
public @Nullable String getBroadcasterId()

ID of the broadcaster receiving the payload. This is not required if is_global_broadcast is set to true.

isGlobalBroadcast

public boolean isGlobalBroadcast()

Indicates if the message should be sent to all channels where your Extension is active.

Default: false.

getMessage

public String getMessage()

String-encoded JSON message to be sent.

Must not exceed 5 KB in size.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object