Package com.github.twitch4j.graphql

Class TwitchGraphQL

java.lang.Object

com.github.twitch4j.graphql.TwitchGraphQL

@Unofficial
public class TwitchGraphQL
extends Object

This is an unofficial API that is not intended for third-party use. Use at your own risk. Methods could change or stop working at any time.

Constructor Summary

Constructors

Constructor	Description
TwitchGraphQL(String baseUrl, String userAgent, EventManager eventManager, String clientId, OAuth2Credential defaultToken, ProxyConfig proxyConfig, boolean batchingEnabled, Integer timeout, Map<String,String> additionalHeaders)	Constructor

Method Summary

Modifier and Type	Method	Description
CommandAcceptFriendRequest	acceptFriendRequest(OAuth2Credential auth, String targetId)
CommandAddChannelBlockedTerm	addChannelBlockedTerm(OAuth2Credential auth, String channelId, Boolean isModEditable, List<String> phrases)	Deprecated.
CommandAddChannelPermittedTerm	addChannelPermittedTerm(OAuth2Credential auth, String channelId, List<String> phrases)
CommandApproveUnbanRequest	approveUnbanRequest(OAuth2Credential auth, String id, String message)
CommandArchivePoll	archivePoll(OAuth2Credential auth, String pollId)
CommandBanUser	banUser(OAuth2Credential auth, String channelId, String targetUserLogin, String reason)	Deprecated.
CommandBulkApproveUnbanRequest	bulkApproveUnbanRequest(OAuth2Credential auth, List<String> ids)
CommandBulkDenyUnbanRequest	bulkDenyUnbanRequest(OAuth2Credential auth, List<String> ids)
CommandCancelPrediction	cancelPrediction(OAuth2Credential auth, String predictionEventId)
CommandCreateClip	createClip(OAuth2Credential auth, String channelId, Double offsetSeconds, String broadcastId, String videoId)
CommandCreateCommunityPointsGoal	createCommunityPointsGoal(OAuth2Credential auth, com.github.twitch4j.graphql.internal.type.CreateCommunityPointsCommunityGoalInput input)
CommandCreateModComment	createModComment(OAuth2Credential auth, String channelId, String targetId, String text)
CommandCreatePoll	createPoll(OAuth2Credential auth, com.github.twitch4j.graphql.internal.type.CreatePollInput input)
CommandCreatePrediction	createPrediction(OAuth2Credential auth, com.github.twitch4j.graphql.internal.type.CreatePredictionEventInput input)
CommandDeleteChannelBlockedTerm	deleteChannelBlockedTerm(OAuth2Credential auth, String channelId, List<String> phrases)	Deprecated.
CommandDeleteChannelPermittedTerm	deleteChannelPermittedTerm(OAuth2Credential auth, String channelId, List<String> phrases)
CommandDeleteClips	deleteClips(OAuth2Credential auth, List<String> slugs)
CommandDeleteCommunityPointsGoal	deleteCommunityPointsGoal(OAuth2Credential auth, String channelId, String goalId)
CommandDenyUnbanRequest	denyUnbanRequest(OAuth2Credential auth, String id, String message)
CommandFetchActivePredictions	fetchActivePredictions(OAuth2Credential auth, String channelId)
CommandFetchBanStatus	fetchBanStatus(OAuth2Credential auth, String channelId, String userId)
CommandFetchCommunityPointsSettings	fetchChannelPointRewards(OAuth2Credential auth, String channelLogin)
CommandFetchChatHistory	fetchChatHistory(OAuth2Credential auth, String channelId, String userId, String after)
CommandFetchChatters	fetchChatters(OAuth2Credential auth, String channelLogin)
CommandFetchLastBroadcast	fetchLastBroadcast(OAuth2Credential auth, String userId, String userLogin)
CommandFetchLockedPredictions	fetchLockedPredictions(OAuth2Credential auth, String channelId)
CommandFetchModComments	fetchModComments(OAuth2Credential auth, String channelId, String targetId, String after)
CommandFetchMods	fetchMods(OAuth2Credential auth, String channelLogin, String after, Integer limit)
CommandFetchPoll	fetchPoll(OAuth2Credential auth, String pollId)
CommandFetchPrediction	fetchPrediction(OAuth2Credential auth, String predictionEventId)
CommandFetchSquadStream	fetchSquadStream(OAuth2Credential auth, String id)
CommandFetchUnbanRequests	fetchUnbanRequests(OAuth2Credential auth, String channelLogin, String cursor, Integer limit, com.github.twitch4j.graphql.internal.type.UnbanRequestsSortOrder order, com.github.twitch4j.graphql.internal.type.UnbanRequestStatus status, String userId)
CommandFetchUser	fetchUser(OAuth2Credential auth, String userId, String userLogin)
CommandFetchUserEmoteSets	fetchUserEmoteSets(OAuth2Credential auth, String userId)
CommandFetchUserSubscriptions	fetchUserSubscriptions(OAuth2Credential auth, String userId, Integer first, String after)
CommandFetchVideoComments	fetchVideoComments(OAuth2Credential auth, String channelId, String videoId, String id, String after, String before, Integer first, Integer last)
CommandFetchVips	fetchVips(OAuth2Credential auth, String channelLogin, String after, Integer limit)
CommandFollowUser	followUser(OAuth2Credential auth, Long targetUserId, Boolean goLiveNotification)	Follow a user
CommandLockPrediction	lockPrediction(OAuth2Credential auth, String predictionEventId)
CommandRejectFriendRequest	rejectFriendRequest(OAuth2Credential auth, String targetId)
CommandResolvePrediction	resolvePrediction(OAuth2Credential auth, String predictionEventId, String outcomeId)
CommandTerminatePoll	terminatePoll(OAuth2Credential auth, String pollId)
CommandUnfollowUser	unfollowUser(OAuth2Credential auth, Long targetUserId)	Unfollow a user
CommandUpdateClip	updateClip(OAuth2Credential auth, String slug, String newTitle)
CommandUpdateCommunityPointsGoal	updateCommunityPointsGoal(OAuth2Credential auth, com.github.twitch4j.graphql.internal.type.UpdateCommunityPointsCommunityGoalInput input)
CommandUpdateCustomRedemptionStatus	updateRedemptionStatus(OAuth2Credential auth, String channelId, String redemptionId, com.github.twitch4j.graphql.internal.type.CommunityPointsCustomRewardRedemptionStatus newStatus)
CommandUpdateCustomRedemptionStatuses	updateRedemptionStatuses(OAuth2Credential auth, String channelId, List<String> redemptionIds, com.github.twitch4j.graphql.internal.type.CommunityPointsCustomRewardRedemptionStatus oldStatus, com.github.twitch4j.graphql.internal.type.CommunityPointsCustomRewardRedemptionStatus newStatus)

Methods inherited from class java.lang.Object

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

Constructor Details

TwitchGraphQL

public TwitchGraphQL(String baseUrl,
 String userAgent,
 EventManager eventManager,
 String clientId,
 OAuth2Credential defaultToken,
 ProxyConfig proxyConfig,
 boolean batchingEnabled,
 Integer timeout,
 Map<String,String> additionalHeaders)

Constructor

Parameters:

baseUrl - Base Url

userAgent - User Agent

eventManager - Event Manager

clientId - Client Id

defaultToken - Default Token

proxyConfig - Proxy Config

batchingEnabled - Query Batching

timeout - Query Timeout

additionalHeaders - Custom headers

Method Details

fetchBanStatus

public CommandFetchBanStatus fetchBanStatus(OAuth2Credential auth,
 String channelId,
 String userId)

addChannelBlockedTerm

@Deprecated
public CommandAddChannelBlockedTerm addChannelBlockedTerm(OAuth2Credential auth,
 String channelId,
 Boolean isModEditable,
 List<String> phrases)

Deprecated.

deleteChannelBlockedTerm

@Deprecated
public CommandDeleteChannelBlockedTerm deleteChannelBlockedTerm(OAuth2Credential auth,
 String channelId,
 List<String> phrases)

Deprecated.

addChannelPermittedTerm

public CommandAddChannelPermittedTerm addChannelPermittedTerm(OAuth2Credential auth,
 String channelId,
 List<String> phrases)

deleteChannelPermittedTerm

public CommandDeleteChannelPermittedTerm deleteChannelPermittedTerm(OAuth2Credential auth,
 String channelId,
 List<String> phrases)

fetchChatHistory

public CommandFetchChatHistory fetchChatHistory(OAuth2Credential auth,
 String channelId,
 String userId,
 String after)

fetchChatters

public CommandFetchChatters fetchChatters(OAuth2Credential auth,
 String channelLogin)

createClip

public CommandCreateClip createClip(OAuth2Credential auth,
 String channelId,
 Double offsetSeconds,
 String broadcastId,
 String videoId)

deleteClips

public CommandDeleteClips deleteClips(OAuth2Credential auth,
 List<String> slugs)

updateClip

public CommandUpdateClip updateClip(OAuth2Credential auth,
 String slug,
 String newTitle)

fetchChannelPointRewards

public CommandFetchCommunityPointsSettings fetchChannelPointRewards(OAuth2Credential auth,
 String channelLogin)

createCommunityPointsGoal

public CommandCreateCommunityPointsGoal createCommunityPointsGoal(OAuth2Credential auth,
 com.github.twitch4j.graphql.internal.type.CreateCommunityPointsCommunityGoalInput input)

deleteCommunityPointsGoal

public CommandDeleteCommunityPointsGoal deleteCommunityPointsGoal(OAuth2Credential auth,
 String channelId,
 String goalId)

updateCommunityPointsGoal

public CommandUpdateCommunityPointsGoal updateCommunityPointsGoal(OAuth2Credential auth,
 com.github.twitch4j.graphql.internal.type.UpdateCommunityPointsCommunityGoalInput input)

updateRedemptionStatus

public CommandUpdateCustomRedemptionStatus updateRedemptionStatus(OAuth2Credential auth,
 String channelId,
 String redemptionId,
 com.github.twitch4j.graphql.internal.type.CommunityPointsCustomRewardRedemptionStatus newStatus)

updateRedemptionStatuses

public CommandUpdateCustomRedemptionStatuses updateRedemptionStatuses(OAuth2Credential auth,
 String channelId,
 List<String> redemptionIds,
 com.github.twitch4j.graphql.internal.type.CommunityPointsCustomRewardRedemptionStatus oldStatus,
 com.github.twitch4j.graphql.internal.type.CommunityPointsCustomRewardRedemptionStatus newStatus)

acceptFriendRequest

public CommandAcceptFriendRequest acceptFriendRequest(OAuth2Credential auth,
 String targetId)

rejectFriendRequest

public CommandRejectFriendRequest rejectFriendRequest(OAuth2Credential auth,
 String targetId)

fetchLastBroadcast

public CommandFetchLastBroadcast fetchLastBroadcast(OAuth2Credential auth,
 String userId,
 String userLogin)

createModComment

public CommandCreateModComment createModComment(OAuth2Credential auth,
 String channelId,
 String targetId,
 String text)

fetchModComments

public CommandFetchModComments fetchModComments(OAuth2Credential auth,
 String channelId,
 String targetId,
 String after)

fetchMods

public CommandFetchMods fetchMods(OAuth2Credential auth,
 String channelLogin,
 String after,
 Integer limit)

archivePoll

public CommandArchivePoll archivePoll(OAuth2Credential auth,
 String pollId)

createPoll

public CommandCreatePoll createPoll(OAuth2Credential auth,
 com.github.twitch4j.graphql.internal.type.CreatePollInput input)

fetchPoll

public CommandFetchPoll fetchPoll(OAuth2Credential auth,
 String pollId)

terminatePoll

public CommandTerminatePoll terminatePoll(OAuth2Credential auth,
 String pollId)

cancelPrediction

public CommandCancelPrediction cancelPrediction(OAuth2Credential auth,
 String predictionEventId)

createPrediction

public CommandCreatePrediction createPrediction(OAuth2Credential auth,
 com.github.twitch4j.graphql.internal.type.CreatePredictionEventInput input)

fetchActivePredictions

public CommandFetchActivePredictions fetchActivePredictions(OAuth2Credential auth,
 String channelId)

fetchLockedPredictions

public CommandFetchLockedPredictions fetchLockedPredictions(OAuth2Credential auth,
 String channelId)

fetchPrediction

public CommandFetchPrediction fetchPrediction(OAuth2Credential auth,
 String predictionEventId)

lockPrediction

public CommandLockPrediction lockPrediction(OAuth2Credential auth,
 String predictionEventId)

resolvePrediction

public CommandResolvePrediction resolvePrediction(OAuth2Credential auth,
 String predictionEventId,
 String outcomeId)

fetchSquadStream

public CommandFetchSquadStream fetchSquadStream(OAuth2Credential auth,
 String id)

approveUnbanRequest

public CommandApproveUnbanRequest approveUnbanRequest(OAuth2Credential auth,
 String id,
 String message)

bulkApproveUnbanRequest

public CommandBulkApproveUnbanRequest bulkApproveUnbanRequest(OAuth2Credential auth,
 List<String> ids)

bulkDenyUnbanRequest

public CommandBulkDenyUnbanRequest bulkDenyUnbanRequest(OAuth2Credential auth,
 List<String> ids)

denyUnbanRequest

public CommandDenyUnbanRequest denyUnbanRequest(OAuth2Credential auth,
 String id,
 String message)

fetchUnbanRequests

public CommandFetchUnbanRequests fetchUnbanRequests(OAuth2Credential auth,
 String channelLogin,
 String cursor,
 Integer limit,
 com.github.twitch4j.graphql.internal.type.UnbanRequestsSortOrder order,
 com.github.twitch4j.graphql.internal.type.UnbanRequestStatus status,
 String userId)

banUser

@Deprecated
public CommandBanUser banUser(OAuth2Credential auth,
 String channelId,
 String targetUserLogin,
 String reason)

Deprecated.

fetchUser

public CommandFetchUser fetchUser(OAuth2Credential auth,
 String userId,
 String userLogin)

fetchUserEmoteSets

public CommandFetchUserEmoteSets fetchUserEmoteSets(OAuth2Credential auth,
 String userId)

fetchUserSubscriptions

public CommandFetchUserSubscriptions fetchUserSubscriptions(OAuth2Credential auth,
 String userId,
 Integer first,
 String after)

fetchVideoComments

public CommandFetchVideoComments fetchVideoComments(OAuth2Credential auth,
 String channelId,
 String videoId,
 String id,
 String after,
 String before,
 Integer first,
 Integer last)

fetchVips

public CommandFetchVips fetchVips(OAuth2Credential auth,
 String channelLogin,
 String after,
 Integer limit)

followUser

public CommandFollowUser followUser(OAuth2Credential auth,
 Long targetUserId,
 Boolean goLiveNotification)

Follow a user

Parameters:

auth - Credential

targetUserId - target user, that the user the auth token was provided for will follow

goLiveNotification - should the follower be notified every time a streamer goes live?

Returns:

CommandFollowUser

unfollowUser

public CommandUnfollowUser unfollowUser(OAuth2Credential auth,
 Long targetUserId)

Unfollow a user

Parameters:

auth - Credential

targetUserId - target user, that the user the auth token was provided for will follow

Returns:

CommandUnfollowUser