Twitch4J

https://twitch4j.github.io/javadoc/
Admin
Twitch4J is a Java library for interacting with the Twitch API, providing modules for chat,...
Tokens:69,608
Snippets:746
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### startCommercial

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Starts a commercial on a specified channel.

```APIDOC
## startCommercial

### Description
Starts a commercial on a specified channel.

### Parameters
- **authToken** (String) - Required
- **broadcasterId** (String) - Required
- **length** (Integer) - Required
```

--------------------------------

### startCommercial(String, String, Integer)

Source: https://twitch4j.github.io/javadoc/index-all.html

Starts a commercial on a specified channel.

```APIDOC
## startCommercial(String, String, Integer)

### Description
Starts a commercial on a specified channel.

### Parameters
- **authToken** (String) - Required - The OAuth token for the broadcaster.
- **broadcasterId** (String) - Required - The ID of the broadcaster.
- **length** (Integer) - Required - The length of the commercial in seconds.
```

--------------------------------

### getExtensionBitsProducts

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of Bits products that belongs to an Extension.

```APIDOC
## getExtensionBitsProducts

### Description
Gets a list of Bits products that belongs to an Extension.

### Method
SDK Method

### Parameters
- **authToken** (String) - Required - App Access Token associated with the Extension client ID
- **includeAll** (Boolean) - Optional - Whether Bits products that are disabled/expired should be included in the response. Default: false

### Returns
- **ExtensionBitsProductList**
```

--------------------------------

### getExtensionBitsProducts

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of Bits products that belongs to an Extension.

```APIDOC
## getExtensionBitsProducts(String authToken, Boolean includeAll)

### Description
Gets a list of Bits products that belongs to an Extension.

### Parameters
- **authToken** (String) - Required - The OAuth token for authentication.
- **includeAll** (Boolean) - Optional - Whether to include all products.
```

--------------------------------

### getUserExtensions

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Get User Extensions

```APIDOC
## getUserExtensions

### Description
Get User Extensions

### Method
SDK Method

### Signature
`HystrixCommand<ExtensionList> getUserExtensions(String authToken)`
```

--------------------------------

### getVideos

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Get Videos

```APIDOC
## getVideos

### Description
Get Videos

### Method
SDK Method

### Signature
`HystrixCommand<VideoList> getVideos(String authToken, List<String> id, String userId, String gameId, String language, Video.SearchPeriod period, Video.SearchOrder sort, Video.Type type, Integer limit, String after, String before)`
```

--------------------------------

### getClip

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets details about a specified clip.

```APIDOC
## getClip

### Description
Gets details about a specified clip.

### Parameters
- **slug** (String) - Required - The globally unique string to reference the clip

### Returns
- **KrakenClip** (Object)
```

--------------------------------

### getUsers

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Get Users

```APIDOC
## getUsers

### Description
Get Users

### Method
SDK Method

### Signature
`HystrixCommand<UserList> getUsers(String authToken, List<String> userIds, List<String> userNames)`
```

--------------------------------

### getAutoModSettings

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the broadcaster’s AutoMod settings.

```APIDOC
## getAutoModSettings

### Description
Gets the broadcaster’s AutoMod settings, which are used to automatically block inappropriate or harassing messages from appearing in the broadcaster’s chat room.

### Parameters
- **authToken** (String) - Required
- **broadcasterId** (String) - Required
- **moderatorId** (String) - Required

### Returns
- **AutoModSettingsWrapper**
```

--------------------------------

### getExtensionLiveChannels

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Returns a list of live channels that have installed or activated a specific Extension.

```APIDOC
## getExtensionLiveChannels

### Description
Returns one page of live channels that have installed or activated a specific Extension, identified by a client ID value assigned to the Extension when it is created.

### Parameters
- **authToken** (String) - Required - User OAuth Token or App Access Token.
- **extensionId** (String) - Required - ID of the Extension to search for.
- **limit** (Integer) - Optional - Maximum number of objects to return. Maximum: 100. Default: 20.
- **after** (String) - Optional - The cursor used to fetch the next page of data.

### Response
- **ExtensionLiveChannelsList** (Object) - Returns a page of live channels.
```

--------------------------------

### getCollection

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets all items (videos) in a specified collection.

```APIDOC
## getCollection

### Description
Gets all items (videos) in a specified collection.

### Parameters
- **collectionId** (String) - Required - The ID of the collection.

### Returns
- **KrakenCollection** (Object)
```

--------------------------------

### getAllTeams(Integer, Integer)

Source: https://twitch4j.github.io/javadoc/index-all.html

Get All Teams.

```APIDOC
## getAllTeams(Integer, Integer)

### Description
Get All Teams. Note: This method is deprecated.
```

--------------------------------

### getChatSettings

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the broadcaster’s chat settings.

```APIDOC
## getChatSettings

### Description
Gets the broadcaster’s chat settings.

### Parameters
- **authToken** (String) - Required - OAuth access token. To read the non-moderator chat delay, a moderator's user access token must be specified with the moderator:read:chat_settings scope.
- **broadcasterId** (String) - Required - The ID of the broadcaster whose chat settings you want to get.
- **moderatorId** (String) - Optional - The ID of a user that has permission to moderate the broadcaster’s chat room. Required only to access non moderator chat delay fields.

### Response
- **Returns** (ChatSettingsWrapper) - The broadcaster's chat settings.
```

--------------------------------

### getChatSettings

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the broadcaster’s chat settings.

```APIDOC
## getChatSettings(String authToken, String broadcasterId, String moderatorId)

### Description
Gets the broadcaster’s chat settings.

### Parameters
- **authToken** (String) - Required
- **broadcasterId** (String) - Required
- **moderatorId** (String) - Required
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/pubsub/TwitchPubSubBuilder.html

Constructs the TwitchPubSub client using the configured settings.

```APIDOC
## TwitchPubSub build()

### Description
Builds and returns the TwitchPubSub client instance based on the current configuration.

### Returns
- **TwitchPubSub** - The configured TwitchPubSub client.
```

--------------------------------

### getChannelFollowers

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets a list of users who follow a specified channel, sorted by the date when they started following the channel.

```APIDOC
## getChannelFollowers

### Description
Gets a list of users who follow a specified channel, sorted by the date when they started following the channel (newest first, unless specified otherwise).

### Parameters
- **channelId** (String) - Required - Channel Id
- **limit** (Integer) - Optional - Maximum number of objects to return. Default: 25. Maximum: 100.
- **offset** (Integer) - Optional - Object offset for pagination of results. Default: 0.
- **cursor** (String) - Optional - Tells the server where to start fetching the next set of results.
- **direction** (String) - Optional - Direction of sorting. Valid values: asc, desc (newest first). Default: desc.

### Returns
- **KrakenFollowList**
```

--------------------------------

### apply(okhttp3.OkHttpClient.Builder builder)

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/config/ProxyConfig.html

Applies the current proxy configuration to an OkHttpClient builder instance.

```APIDOC
## apply(okhttp3.OkHttpClient.Builder builder)

### Description
Applies this proxy configuration to an OkHttpClient builder.

### Parameters
- **builder** (okhttp3.OkHttpClient.Builder) - The builder of the Http Client.
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientBuilder.html

Finalizes the configuration and builds the TwitchClient instance.

```APIDOC
## TwitchClient build()

### Description
Initializes and returns the configured TwitchClient class.

### Returns
- **TwitchClient** - The fully initialized TwitchClient instance.
```

--------------------------------

### connect()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/eventsub/socket/IEventSubSocket.html

Establishes a connection to the EventSub WebSocket server.

```APIDOC
### void connect()

Establishes a connection to the EventSub WebSocket server.
```

--------------------------------

### getSubscriptions

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Get all subscribers of a channel.

```APIDOC
## getSubscriptions(String authToken, String broadcasterId, String after, String before, Integer limit)

### Description
Get all subscribers of a channel.
```

--------------------------------

### getOrInitializeBucket

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/util/TwitchLimitRegistry.html

Retrieves or creates a rate-limit bucket for a user.

```APIDOC
## Bucket getOrInitializeBucket(String userId, TwitchLimitType limitType, List<Bandwidth> limit)

### Description
Obtains or creates the Bucket for a certain user and rate limit type.

### Parameters
- **userId** (String) - Required - The id of the user in question.
- **limitType** (TwitchLimitType) - Required - The type of rate limit in question.
- **limit** (List<Bandwidth>) - Required - The default bandwidth settings for this user and rate limit type.

### Returns
- **Bucket** - The shared rate limit bucket for this user and limit type.
```

--------------------------------

### getChannelInformation

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets channel information for users.

```APIDOC
## getChannelInformation

### Description
Gets channel information for users.

### Parameters
- **authToken** (String) - Required - Auth Token
- **broadcasterIds** (List<String>) - Required - IDs of the channels to be retrieved (up to 100)

### Response
- **ChannelInformationList** (Object) - Returns channel information.
```

--------------------------------

### getLiveChannelsWithExtensionActivated

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/extensions/TwitchExtensions.html

Retrieves a list of live channels that have installed and activated a specific extension.

```APIDOC
## getLiveChannelsWithExtensionActivated

### Description
Returns one page of live channels that have installed and activated a specified extension.

### Parameters
- **clientId** (String) - Required - The client ID assigned to the extension.
- **cursor** (String) - Optional - Cursor for forward pagination.

### Returns
- ChannelList
```

--------------------------------

### getBitsLeaderboard

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a ranked list of Bits leaderboard information for an authorized broadcaster.

```APIDOC
## getBitsLeaderboard

### Description
Gets a ranked list of Bits leaderboard information for an authorized broadcaster.

### Method
SDK Method

### Parameters
- **authToken** (String) - Required - Auth Token
- **count** (Integer) - Optional - Number of results to be returned. Maximum: 100. Default: 10.
- **period** (String) - Optional - Time period over which data is aggregated (PST time zone). Default: "all".
- **startedAt** (String) - Optional - Timestamp for the period over which the returned data is aggregated. Must be in RFC 3339 format.
- **userId** (String) - Optional - ID of the user whose results are returned.

### Returns
- **BitsLeaderboard**
```

--------------------------------

### TwitchHelixBuilder.builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelixBuilder.html

Initializes a new instance of the TwitchHelixBuilder.

```APIDOC
## static TwitchHelixBuilder builder()

### Description
Initializes the builder to start configuring a new Twitch Helix API client.

### Returns
- **TwitchHelixBuilder** - A new instance of the builder.
```

--------------------------------

### getStreams

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets information about active streams.

```APIDOC
## getStreams(String authToken, String after, String before, Integer limit, List<String> gameIds, List<String> language, List<String> userIds, List<String> userLogins)

### Description
Gets information about active streams.
```

--------------------------------

### getUserExtensions(String)

Source: https://twitch4j.github.io/javadoc/index-all.html

Get User Extensions via the TwitchHelix interface.

```APIDOC
## getUserExtensions(String)

### Description
Get User Extensions.

### Method
SDK Method

### Parameters
- **authToken** (String) - Required
```

--------------------------------

### getEventSubSubscriptions

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Get a list of your EventSub subscriptions.

```APIDOC
## getEventSubSubscriptions(String authToken, EventSubSubscriptionStatus status, SubscriptionType<?,?,?> type, String userId, String after, Integer limit)

### Description
Get a list of your EventSub subscriptions.
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientBuilder.html

Constructs the TwitchClient instance based on the configured options.

```APIDOC
### Method
`TwitchClient build()`

### Description
Finalizes the configuration and returns a fully initialized TwitchClient instance.
```

--------------------------------

### connect()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/pubsub/TwitchPubSub.html

Establishes a connection to the Twitch PubSub WebSocket.

```APIDOC
## void connect()

### Description
Connects to the Twitch PubSub WebSocket service.

### Method
void connect()
```

--------------------------------

### getGames

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets game information by game ID or game name or IGBD ID.

```APIDOC
## getGames(String authToken, List<String> id, List<String> name, List<String> igdbId)

### Description
Gets game information by game ID or game name or IGBD ID.
```

--------------------------------

### TwitchHelix.getChatSettings(String, String, String)

Source: https://twitch4j.github.io/javadoc/index-all.html

Gets the broadcaster’s chat settings.

```APIDOC
## getChatSettings(String, String, String)

### Description
Gets the broadcaster’s chat settings.

### Method
Interface Method

### Parameters
- **broadcasterId** (String) - Required
- **moderatorId** (String) - Optional
- **token** (String) - Optional
```

--------------------------------

### getClips

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets clip information by clip ID, broadcaster ID, or game ID.

```APIDOC
## getClips(String authToken, String broadcasterId, String gameId, List<String> ids, String after, String before, Integer limit, Instant startedAt, Instant endedAt, Boolean isFeatured)

### Description
Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/pool/TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder.html

Builds the connection pool instance.

```APIDOC
### Method
`build()`

### Description
Constructs and returns the configured connection pool instance.

### Returns
- **C2** - The built connection pool.
```

--------------------------------

### connect()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/pubsub/TwitchPubSub.html

Establishes a connection to the Twitch PubSub WebSocket service.

```APIDOC
## connect()

### Description
Connects the client to the Twitch PubSub WebSocket service.

### Method
void connect()
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientPoolBuilder.html

Finalizes the configuration and builds the TwitchClientPool instance.

```APIDOC
## TwitchClientPool build()

### Description
Initializes and returns the configured TwitchClientPool class.

### Returns
- **TwitchClientPool** - The initialized class.
```

--------------------------------

### getChannelVips

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of the channel’s VIPs.

```APIDOC
## getChannelVips

### Description
Gets a list of the channel’s VIPs.

### Parameters
- **authToken** (String) - Required - Broadcaster's user access token that includes the channel:read:vips scope.
- **broadcasterId** (String) - Required - The ID of the broadcaster whose list of VIPs you want to get.
- **userIds** (List<String>) - Optional - Filters the list for specific VIPs.
- **limit** (Integer) - Optional - The maximum number of items to return per page. Default: 20.
- **after** (String) - Optional - The cursor used to get the next page of results.

### Returns
- **ChannelVipList**
```

--------------------------------

### getExtensionConfigurationSegment

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/extensions/TwitchExtensions.html

Gets a broadcaster or developer configuration segment for a specified channel, or the global configuration segment.

```APIDOC
## getExtensionConfigurationSegment

### Description
Gets a broadcaster or developer configuration segment for a specified channel, or the global configuration segment. Each segment can be retrieved at most 20 times per minute.

### Parameters
- **clientId** (String) - The client ID identifying the extension.
- **jsonWebToken** (String) - Signed JWT created by the EBS.
- **segmentType** (ConfigurationSegmentType) - The segment type.
- **channelId** (String) - The channel id of the broadcaster (must be null for GLOBAL).
```

--------------------------------

### builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/pubsub/TwitchPubSubBuilder.html

Initializes a new instance of the TwitchPubSubBuilder.

```APIDOC
## static TwitchPubSubBuilder builder()

### Description
Initializes the builder for creating a TwitchPubSub client.

### Returns
- **TwitchPubSubBuilder** - The initialized builder instance.
```

--------------------------------

### Configuration Methods

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/graphql/TwitchGraphQLBuilder.html

Methods used to configure the builder instance.

```APIDOC
## Configuration Methods

### Description
These methods allow for the fluent configuration of the TwitchGraphQL client.

### Methods
- **withClientId(String clientId)**: Sets the Client Id.
- **withClientSecret(String clientSecret)**: Sets the Client Secret (Deprecated).
- **withEnableBatching(boolean enableBatching)**: Configures whether GraphQL Queries should be batched.
- **withTimeout(Integer timeout)**: Sets the default request timeout.
- **withUserAgent(String userAgent)**: Sets the User Agent string.
- **withHeaders(Map<String,String> headers)**: Sets additional headers for outbound requests.
- **withEventManager(EventManager eventManager)**: Sets the Event Manager.
- **withDefaultEventHandler(Class<? extends IEventHandler> defaultEventHandler)**: Sets the default event handler.
- **withProxyConfig(ProxyConfig proxyConfig)**: Sets the proxy configuration.
- **withDefaultFirstPartyToken(OAuth2Credential defaultFirstPartyToken)**: Sets the default first-party OAuth token.
```

--------------------------------

### getTeams

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets information for a specific Twitch Team.

```APIDOC
## getTeams(String authToken, String name, String id)

### Description
Gets information for a specific Twitch Team.
```

--------------------------------

### getStreamKey

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the channel stream key for a user.

```APIDOC
## getStreamKey(String authToken, String broadcasterId)

### Description
Gets the channel stream key for a user.
```

--------------------------------

### BucketUtils.createBucket

Source: https://twitch4j.github.io/javadoc/index-all.html

Utility methods to create rate-limiting buckets with specified bandwidth configurations.

```APIDOC
## BucketUtils.createBucket

### Description
Creates a bucket with the specified bandwidth or bandwidths for rate limiting.

### Method
Static Method

### Parameters
- **bandwidth** (Bandwidth or Bandwidth... or Iterable<Bandwidth>) - Required - The bandwidth configuration(s) to apply to the bucket.
```

--------------------------------

### simple(long, Duration, String)

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/util/BucketUtils.html

Creates a Bandwidth configuration with a specified capacity, refill period, and optional ID.

```APIDOC
## static Bandwidth simple(long capacity, Duration greedyRefillPeriod, String id)

### Description
Creates a bandwidth with the specified capacity and refill rate. Note: the greedy refill algorithm allows for exceeding the specified capacity within the refill period.

### Parameters
- **capacity** (long) - The bandwidth capacity.
- **greedyRefillPeriod** (Duration) - The amount of time for the bucket bandwidth to be completely refilled.
- **id** (String) - The bandwidth id.

### Returns
- **Bandwidth** - The configured bandwidth object.
```

--------------------------------

### getVideos

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets video information by video ID, user ID, or game ID. Supports pagination and various filters for user or game lookups.

```APIDOC
## getVideos

### Description
Gets video information by video ID (one or more), user ID (one only), or game ID (one only). The response has a JSON payload with a data field containing an array of video elements.

### Parameters
- **authToken** (String) - Required - User or App Access Token
- **id** (String) - Required - ID of the video being queried. Limit: 100. If this is specified, you cannot use any of the optional query string parameters.
- **userId** (String) - Required - ID of the user who owns the video. Limit 1.
- **gameId** (String) - Required - ID of the game the video is of. Limit 1.
- **language** (String) - Optional - Language of the video being queried. Limit: 1.
- **period** (String) - Optional - Period during which the video was created. Valid values: "all", "day", "week", "month". Default: "all".
- **sort** (String) - Optional - Sort order of the videos. Valid values: "time", "trending", "views". Default: "time".
- **type** (String) - Optional - Type of video. Valid values: "all", "upload", "archive", "highlight". Default: "all".
- **after** (String) - Optional - Cursor for forward pagination.
- **before** (String) - Optional - Cursor for backward pagination.
- **limit** (Integer) - Optional - Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.
```

--------------------------------

### getCollectionsByChannel

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets all collections owned by a specified channel.

```APIDOC
## getCollectionsByChannel

### Description
Gets all collections owned by a specified channel.

### Parameters
- **channelId** (String) - Required - The ID of the channel.
- **limit** (Integer) - Optional - Maximum number of most-recent objects to return.
- **cursor** (String) - Optional - Tells the server where to start fetching the next set of results.
- **videoId** (String) - Optional - Returns only collections containing the specified video.

### Returns
- **KrakenCollectionList** (Object)
```

--------------------------------

### createBucket

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/util/BucketUtils.html

Creates a new Bucket instance based on provided Bandwidth limits.

```APIDOC
## static Bucket createBucket(Bandwidth... limits)

### Description
Creates a bucket with the specified bandwidths.

### Parameters
- **limits** (Bandwidth...) - The bandwidths to apply to the bucket.

### Returns
- **Bucket** - The created bucket instance.
```

--------------------------------

### IEventSubSocket.connect()

Source: https://twitch4j.github.io/javadoc/index-all.html

Establishes a connection to the EventSub WebSocket server.

```APIDOC
## connect()

### Description
Establishes a connection to the EventSub WebSocket server.

### Method
void connect()

### Interface
com.github.twitch4j.eventsub.socket.IEventSubSocket
```

--------------------------------

### builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientBuilder.html

Initializes a new instance of the TwitchClientBuilder.

```APIDOC
## static TwitchClientBuilder builder()

### Description
Initializes the builder to start configuring a TwitchClient instance.

### Returns
- **TwitchClientBuilder** - The initialized builder instance.
```

--------------------------------

### getCollectionMetadata

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets summary information about a specified collection.

```APIDOC
## getCollectionMetadata

### Description
Gets summary information about a specified collection.

### Parameters
- **collectionId** (String) - Required - The ID of the collection.

### Returns
- **KrakenCollectionMetadata** (Object)
```

--------------------------------

### builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientBuilder.html

Initializes a new instance of the TwitchClientBuilder.

```APIDOC
### Method
`static TwitchClientBuilder builder()`

### Description
Initializes the builder to start configuring a new TwitchClient instance.
```

--------------------------------

### getAllChatEmoticons

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets all chat emoticons (including their images).

```APIDOC
## getAllChatEmoticons

### Description
Gets all chat emoticons (including their images). Caution: This endpoint returns a large amount of data.

### Returns
- **EmoticonList** (Object)
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/pubsub/TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder.html

Builds and returns a new instance of the TwitchPubSubConnectionPool.

```APIDOC
## build()

### Description
Constructs a new TwitchPubSubConnectionPool instance based on the configured parameters.

### Returns
- **C** - The constructed TwitchPubSubConnectionPool instance.
```

--------------------------------

### getChatEmoticons

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets all chat emoticons (not including their images).

```APIDOC
## getChatEmoticons

### Description
Gets all chat emoticons (not including their images). Caution: this endpoint returns a large amount of data.

### Returns
- **SimpleEmoticonList** (Object)
```

--------------------------------

### TwitchHelixBuilder.build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelixBuilder.html

Constructs the TwitchHelix client instance based on the configured parameters.

```APIDOC
## TwitchHelix build()

### Description
Builds and returns the configured Twitch API Client (Helix).

### Returns
- **TwitchHelix** - The configured Helix API client instance.
```

--------------------------------

### getContentClassificationLabels

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets information about Twitch content classification labels.

```APIDOC
## getContentClassificationLabels

### Description
Gets information about Twitch content classification labels.

### Parameters
- **authToken** (String) - App Access Token or User Access Token.
- **locale** (String) - Locale for the Content Classification Labels. Default: "en-US".

### Returns
- **ContentClassificationList**
```

--------------------------------

### getUserBlockList(String, String, String, Integer)

Source: https://twitch4j.github.io/javadoc/index-all.html

Gets a specified user’s block list via the TwitchHelix interface.

```APIDOC
## getUserBlockList(String, String, String, Integer)

### Description
Gets a specified user’s block list.

### Method
SDK Method

### Parameters
- **authToken** (String) - Required
- **userId** (String) - Required
- **first** (String) - Optional
- **after** (Integer) - Optional
```

--------------------------------

### getCharityCampaign

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets information about the charity campaign that a broadcaster is running.

```APIDOC
## getCharityCampaign

### Description
Gets information about the charity campaign that a broadcaster is running, such as their fundraising goal and the amount that’s been donated so far. The ID in the broadcaster_id query parameter must match the user ID in the access token.

### Method
SDK Method

### Signature
com.netflix.hystrix.HystrixCommand<CharityCampaignWrapper> getCharityCampaign(String authToken, String broadcasterId)

### Parameters
- **authToken** (String) - Required - Broadcaster user access token with the channel:read:charity scope.
- **broadcasterId** (String) - Required - The ID of the broadcaster that’s actively running a charity campaign.

### Returns
- CharityCampaignWrapper
```

--------------------------------

### connect()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/chat/TwitchChat.html

Initiates a connection to the Twitch IRC WebSocket server.

```APIDOC
## connect()

### Description
Connects the client to the Twitch IRC-WS server.

### Method
void connect()

### Parameters
None
```

--------------------------------

### TwitchGraphQLBuilder.builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/graphql/TwitchGraphQLBuilder.html

Initializes a new instance of the TwitchGraphQLBuilder.

```APIDOC
## TwitchGraphQLBuilder.builder()

### Description
Initializes the builder for the Twitch GraphQL client.

### Returns
- **TwitchGraphQLBuilder** - The initialized builder instance.
```

--------------------------------

### TwitchHelix.getChatters(String, String, String, Integer, String)

Source: https://twitch4j.github.io/javadoc/index-all.html

Gets the list of users that are connected to the specified broadcaster’s chat session.

```APIDOC
## getChatters(String, String, String, Integer, String)

### Description
Gets the list of users that are connected to the specified broadcaster’s chat session.

### Method
Interface Method

### Parameters
- **broadcasterId** (String) - Required
- **moderatorId** (String) - Required
- **token** (String) - Required
- **first** (Integer) - Optional
- **after** (String) - Optional
```

--------------------------------

### getUserChatColor(String, List<String>)

Source: https://twitch4j.github.io/javadoc/index-all.html

Gets the color used for the user’s name in chat via the TwitchHelix interface.

```APIDOC
## getUserChatColor(String, List<String>)

### Description
Gets the color used for the user’s name in chat.

### Method
SDK Method

### Parameters
- **authToken** (String) - Required
- **userIds** (List<String>) - Required
```

--------------------------------

### Create and Configure a TwitchConduitSocketPool

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/eventsub/socket/conduit/TwitchConduitSocketPool.html

Initializes a managed WebSocket pool for an EventSub Conduit and registers a subscription.

```java
 IEventSubConduit conduit = TwitchConduitSocketPool.create(spec -> {
     spec.poolShards(4); // customizable pool size
     spec.clientId("your-client-id");
     spec.clientSecret("your-client-secret");
 });
 conduit.register(SubscriptionTypes.STREAM_ONLINE, b -> b.broadcasterUserId("71092938").build());
 conduit.getEventManager().onEvent(StreamOnlineEvent.class, System.out::println);
```

--------------------------------

### getUserBlockList

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a specified user’s block list.

```APIDOC
## getUserBlockList

### Description
Gets a specified user’s block list.

### Method
SDK Method

### Signature
`HystrixCommand<BlockedUserList> getUserBlockList(String authToken, String userId, String after, Integer limit)`
```

--------------------------------

### getExtensionConfigurationSegment

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the specified configuration segment from the specified extension.

```APIDOC
## getExtensionConfigurationSegment(String jwtToken, String extensionId, List<ExtensionSegment> segment, String broadcasterId)

### Description
Gets the specified configuration segment from the specified extension.
```

--------------------------------

### builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientPoolBuilder.html

Initializes a new instance of the TwitchClientPoolBuilder.

```APIDOC
## static TwitchClientPoolBuilder builder()

### Description
Initializes the builder for creating a TwitchClientPool.

### Returns
- **TwitchClientPoolBuilder** - The initialized builder instance.
```

--------------------------------

### TwitchKrakenBuilder Methods

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKrakenBuilder.html

Methods for configuring and building the Twitch Kraken API client instance.

```APIDOC
## TwitchKrakenBuilder

### Description
A builder class for configuring and initializing the Twitch Kraken API client. This class is deprecated.

### Methods
- **builder()**: Initializes the builder.
- **build()**: Returns a new TwitchKraken instance.
- **withClientId(String clientId)**: Sets the Client ID.
- **withClientSecret(String clientSecret)**: Sets the Client Secret.
- **withUserAgent(String userAgent)**: Sets the User Agent.
- **withRequestQueueSize(Integer requestQueueSize)**: Sets the HTTP request queue size.
- **withBaseUrl(String baseUrl)**: Sets the base URL for the API.
- **withTimeout(Integer timeout)**: Sets the default timeout.
- **withUploadTimeout(Integer uploadTimeout)**: Sets the upload timeout.
- **withLogLevel(feign.Logger.Level logLevel)**: Sets the Feign log level.
- **withProxyConfig(ProxyConfig proxyConfig)**: Sets the proxy configuration.
```

--------------------------------

### TwitchGraphQLBuilder.build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/graphql/TwitchGraphQLBuilder.html

Constructs the TwitchGraphQL client instance using the configured parameters.

```APIDOC
## TwitchGraphQLBuilder.build()

### Description
Builds and returns the Twitch API Client (GraphQL) based on the current builder configuration.

### Returns
- **TwitchGraphQL** - The configured Twitch GraphQL client.
```

--------------------------------

### getCharityCampaign

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets information about the charity campaign that a broadcaster is running.

```APIDOC
## getCharityCampaign(String authToken, String broadcasterId)

### Description
Gets information about the charity campaign that a broadcaster is running, such as their fundraising goal and the amount that’s been donated so far.

### Parameters
- **authToken** (String) - Required
- **broadcasterId** (String) - Required
```

--------------------------------

### getChannelEditors

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets a list of users who are editors for a specified channel.

```APIDOC
## getChannelEditors

### Description
Gets a list of users who are editors for a specified channel.

### Parameters
- **authToken** (String) - Required - User Access Token (scope: channel_read)
- **channelId** (String) - Required - The ID of the channel to retrieve editors from

### Returns
- **KrakenUserList**
```

--------------------------------

### WebsocketConnection.connect()

Source: https://twitch4j.github.io/javadoc/index-all.html

Initiates the connection procedure for a WebSocket.

```APIDOC
## connect()

### Description
Connect to the WebSocket.

### Method
void connect()

### Class
com.github.twitch4j.client.websocket.WebsocketConnection
```

--------------------------------

### getModeratedChannels

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of channels that the specified user has moderator privileges in.

```APIDOC
## getModeratedChannels

### Description
Gets a list of channels that the specified user has moderator privileges in.

### Parameters
- **authToken** (String) - Required - User access token (scope: user:read:moderated_channels).
- **userId** (String) - Required - The user id associated with the user access token.
- **limit** (Integer) - Optional - The maximum number of items to return per page. Default: 20. Max: 100.
- **after** (String) - Optional - The cursor used to get the next page of results.

### Response
- ModeratedChannelList
```

--------------------------------

### getEmoteSets

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets all Twitch emotes for one or more specific emote sets.

```APIDOC
## getEmoteSets

### Description
Gets all Twitch emotes for one or more specific emote sets.

### Method
SDK Method

### Signature
com.netflix.hystrix.HystrixCommand<EmoteList> getEmoteSets(String authToken, Collection<String> ids)

### Parameters
- **authToken** (String) - Required - Any User OAuth Token or App Access Token.
- **ids** (Collection<String>) - Required - IDs of the emote sets. Minimum: 1. Maximum: 25.

### Returns
EmoteList
```

--------------------------------

### build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/eventsub/socket/TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder.html

Builds the TwitchSingleUserEventSocketPool instance.

```APIDOC
### Method
`public abstract C build()`

### Description
Constructs and returns the configured `TwitchSingleUserEventSocketPool` instance.
```

--------------------------------

### getUserChatColor

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the color used for the user’s name in chat.

```APIDOC
## getUserChatColor

### Description
Gets the color used for the user’s name in chat.

### Parameters
- **authToken** (String) - Required - User OAuth Token.
- **userIds** (List<String>) - Required - List of user IDs to retrieve colors for.

### Returns
- **UserChatColorList**
```

--------------------------------

### ProxyConfigBuilder Methods

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/config/ProxyConfig.ProxyConfigBuilder.html

Methods available for configuring and building a ProxyConfig instance.

```APIDOC
## ProxyConfigBuilder Methods

### hostname(String hostname)
Sets the hostname or IP address of the proxy server.

### port(Integer port)
Sets the port of the proxy server.

### username(String username)
Sets the username used to authenticate with the proxy, if applicable.

### password(char[] password)
Sets the password used to authenticate with the proxy, if applicable.

### build()
Constructs and returns a new ProxyConfig instance based on the provided configuration.
```

--------------------------------

### getGlobalChatBadges

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of chat badges that can be used in chat for any channel.

```APIDOC
## getGlobalChatBadges

### Description
Gets a list of chat badges that can be used in chat for any channel.

### Parameters
- **authToken** (String) - Required - User OAuth Token or App Access Token.

### Returns
- **ChatBadgeSetList**
```

--------------------------------

### getUserChatColor

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the color used for the user’s name in chat.

```APIDOC
## getUserChatColor

### Description
Gets the color used for the user’s name in chat.

### Method
SDK Method

### Signature
`HystrixCommand<UserChatColorList> getUserChatColor(String authToken, @NotNull List<String> userIds)`
```

--------------------------------

### withProxyConfig

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientPoolBuilder.html

Sets the Proxy Configuration.

```APIDOC
## TwitchClientPoolBuilder.withProxyConfig(ProxyConfig proxyConfig)

### Description
Sets the Proxy Configuration.

### Parameters
- **proxyConfig** (ProxyConfig) - Required - The proxy configuration.

### Returns
- **TwitchClientPoolBuilder** - A clone of this object with the updated property.
```

--------------------------------

### getUnbanRequests

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of unban requests for a broadcaster’s channel.

```APIDOC
## getUnbanRequests(String authToken, String broadcasterId, String moderatorId, UnbanRequestStatus status, String userId, String after, Integer limit)

### Description
Gets a list of unban requests for a broadcaster’s channel.
```

--------------------------------

### getShieldModeStatus

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the broadcaster’s Shield Mode activation status.

```APIDOC
## getShieldModeStatus(String authToken, String broadcasterId, String moderatorId)

### Description
Gets the broadcaster’s Shield Mode activation status.
```

--------------------------------

### TwitchChatBuilder.build()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/chat/TwitchChatBuilder.html

Builds and returns a configured TwitchChat instance.

```APIDOC
### Method
`TwitchChat build()`

### Description
Constructs the TwitchChat client based on the parameters configured in the builder.
```

--------------------------------

### getPolls

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Get information about all polls or specific polls for a Twitch channel.

```APIDOC
## getPolls(String authToken, String broadcasterId, List<String> pollIds, String after, Integer limit)

### Description
Get information about all polls or specific polls for a Twitch channel.
```

--------------------------------

### TwitchClientBuilder Configuration Methods

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/TwitchClientBuilder.html

Methods used to configure the Twitch client builder with credentials, settings, and module enablement.

```APIDOC
## TwitchClientBuilder Configuration

### Methods
- **withClientId(String clientId)**: Sets the Client ID.
- **withClientSecret(String clientSecret)**: Sets the Client Secret.
- **withUserAgent(String userAgent)**: Sets the User Agent string.
- **withRequestQueueSize(Integer requestQueueSize)**: Sets the HTTP request queue size.
- **withRedirectUrl(String redirectUrl)**: Sets the redirect URL.
- **withTimeout(Integer timeout)**: Sets the default timeout.
- **withEnableHelix(Boolean enableHelix)**: Enables or disables the Helix API.
- **withEnableChat(Boolean enableChat)**: Enables or disables the Chat module.
- **setBotOwnerIds(Collection<String> botOwnerIds)**: Sets the User IDs of Bot Owners for permission handling.
```

--------------------------------

### TwitchChatBuilder.builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/chat/TwitchChatBuilder.html

Initializes a new instance of the TwitchChatBuilder.

```APIDOC
### Method
`static TwitchChatBuilder builder()`

### Description
Initializes the builder for configuring a TwitchChat instance.
```

--------------------------------

### getChatBadgesByChannel

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/kraken/TwitchKraken.html

Gets a list of badges that can be used in chat for a specified channel.

```APIDOC
## getChatBadgesByChannel

### Description
Gets a list of badges that can be used in chat for a specified channel.

### Parameters
- **channelId** (String) - Required - The ID for the specific channel.

### Returns
- **ChatBadges** (Object)
```

--------------------------------

### TwitchChatBuilder.builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/chat/TwitchChatBuilder.html

Initializes a new instance of the TwitchChatBuilder.

```APIDOC
### Method
`public static TwitchChatBuilder builder()`

### Description
Initializes the builder for configuring a TwitchChat instance.

### Returns
- **TwitchChatBuilder** - The initialized builder instance.
```

--------------------------------

### get()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/util/SneakySupplier.html

Retrieves the result of the underlying callable, potentially throwing an exception.

```APIDOC
## Method: get()

### Description
Executes the underlying callable and returns the result. This method implements the Supplier interface.

### Returns
- **T** - The value provided by the supplier.
```

--------------------------------

### Set a User Rate Limit

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/util/TwitchLimitRegistry.html

Configures a specific rate-limit bucket for a user using the singleton instance.

```java
 TwitchLimitRegistry.getInstance().setLimit(
         "149223493",
         TwitchLimitType.CHAT_MESSAGE_LIMIT,
         Collections.singletonList(TwitchChatLimitHelper.MOD_MESSAGE_LIMIT)
     );
```

--------------------------------

### builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/config/ProxyConfig.html

Returns a builder instance for creating a new ProxyConfig object.

```APIDOC
## builder()

### Description
Returns a ProxyConfigBuilder instance to construct a new ProxyConfig object.
```

--------------------------------

### getStreams

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets information about active streams, sorted by number of current viewers.

```APIDOC
## getStreams

### Description
Gets information about active streams. Streams are returned sorted by number of current viewers, in descending order.

### Method
SDK Method

### Signature
com.netflix.hystrix.HystrixCommand<StreamList> getStreams(String authToken, String after, String before, Integer limit, List<String> gameIds, List<String> language, List<String> userIds, List<String> userLogins)

### Parameters
- **authToken** (String) - Required - User or App Access Token.
- **after** (String) - Optional - Cursor for forward pagination.
- **before** (String) - Optional - Cursor for backward pagination.
- **limit** (Integer) - Optional - Maximum number of objects to return (Max: 100, Default: 20).
- **gameIds** (List<String>) - Optional - Returns streams broadcasting a specified game ID.
- **language** (List<String>) - Optional - Stream language (ISO 639-1 code or "other").
- **userIds** (List<String>) - Optional - Returns streams broadcast by one or more specified user IDs.
- **userLogins** (List<String>) - Optional - Returns streams broadcast by one or more specified user login names.

### Returns
- **StreamList**
```

--------------------------------

### getBucket

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/common/util/TwitchLimitRegistry.html

Retrieves an existing rate-limit bucket for a user.

```APIDOC
## Optional<Bucket> getBucket(String userId, TwitchLimitType limitType)

### Description
Obtains the Bucket for a user and rate limit type, if it has been registered.

### Parameters
- **userId** (String) - Required - The id of the user whose rate limit bucket is being requested.
- **limitType** (TwitchLimitType) - Required - The type of rate limit that is being queried.

### Returns
- **Optional<Bucket>** - The shared rate limit bucket for this user and limit type, in an optional wrapper.
```

--------------------------------

### getBlockedTerms

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets the broadcaster’s list of non-private, blocked words or phrases.

```APIDOC
## getBlockedTerms

### Description
Gets the broadcaster’s list of non-private, blocked words or phrases. These are the terms that the broadcaster or moderator added manually, or that were denied by AutoMod.

### Method
SDK Method: com.netflix.hystrix.HystrixCommand<BlockedTermList> getBlockedTerms(String authToken, String broadcasterId, String moderatorId, String after, Integer limit)

### Parameters
- **authToken** (String) - Required - User access token (of the broadcaster or a moderator) with scope set to moderator:read:blocked_terms, associated with moderatorId.
- **broadcasterId** (String) - Required - The ID of the broadcaster whose blocked terms you’re getting.
- **moderatorId** (String) - Required - The ID of a user that has permission to moderate the broadcaster’s chat room.
- **after** (String) - Optional - The cursor used to get the next page of results.
- **limit** (Integer) - Optional - The maximum number of blocked terms to return per page (1-100, default 20).

### Returns
- **BlockedTermList**
```

--------------------------------

### WebsocketConnectionConfig Configuration Methods

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/client/websocket/WebsocketConnectionConfig.html

Methods for configuring WebSocket connection settings and event listeners.

```APIDOC
## Configuration Methods

### wsPingPeriod(int wsPingPeriod)
Sets the WebSocket RFC Ping Period in ms (0 = disabled).

### connectionTimeout(int connectionTimeout)
Sets the timeout in milliseconds for establishing a connection (0 = disabled).

### socketTimeout(int socketTimeout)
Sets the timeout in milliseconds for read and write operations (0 = disabled).

### closeDelay(int closeDelay)
Sets the maximum milliseconds to wait after sending a close frame to receive confirmation.

### headers(Map<String,String> headers)
Sets the WebSocket headers.

### taskExecutor(ScheduledExecutorService taskExecutor)
Sets the task executor for the connection.

### backoffStrategy(IBackoffStrategy backoffStrategy)
Sets the strategy to compute delays between connection retries.

### onStateChanged(BiConsumer<WebsocketConnectionState,WebsocketConnectionState> onStateChanged)
Registers a callback for when the connection state changes.

### onPreConnect(Runnable onPreConnect)
Registers a callback to be executed before connecting.

### onPostConnect(Runnable onPostConnect)
Registers a callback to be executed after connecting.

### onConnected(Runnable onConnected)
Registers a callback for when the connection is successfully established.

### onTextMessage(Consumer<String> onTextMessage)
Registers a callback for receiving text messages.

### onDisconnecting(Runnable onDisconnecting)
Registers a callback for when the state changes to DISCONNECTING.

### onPreDisconnect(Runnable onPreDisconnect)
Registers a callback to be executed before the disconnect.

### onPostDisconnect(Runnable onPostDisconnect)
Registers a callback to be executed after the disconnect.

### onCloseFrame(BiConsumer<Integer,String> onCloseFrame)
Registers a callback for when a close frame is received from the server.

### proxyConfig(ProxyConfig proxyConfig)
Sets the proxy configuration.
```

--------------------------------

### getDropsEntitlements

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets a list of entitlements for a given organization that have been granted to a game, user, or both.

```APIDOC
## getDropsEntitlements

### Description
Gets a list of entitlements for a given organization that have been granted to a game, user, or both.

### Parameters
- **authToken** (String) - Required - App Access OAuth Token. OAuth Token Client ID must have ownership of Game.
- **id** (String) - Optional - Unique Identifier of the entitlement.
- **userId** (String) - Optional - A Twitch User ID.
- **gameId** (String) - Optional - A Twitch Game ID.
- **status** (DropFulfillmentStatus) - Optional - Fulfillment status used to filter entitlements.
- **after** (String) - Optional - The cursor used to fetch the next page of data.
- **limit** (Integer) - Optional - Maximum number of entitlements to return. Default: 20. Max: 1000.

### Response
- **Returns** (DropsEntitlementList) - A list of entitlements.
```

--------------------------------

### TwitchExtensionsCompatibilityLayerBuilder Methods

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/extensions/compat/TwitchExtensionsCompatibilityLayer.TwitchExtensionsCompatibilityLayerBuilder.html

Methods available for configuring the builder instance.

```APIDOC
## Method: clientId(String clientId)
Sets the client ID for the compatibility layer.

## Method: clientSecret(String clientSecret)
Sets the client secret for the compatibility layer.

## Method: userAgent(String userAgent)
Sets the user agent string for requests.

## Method: timeout(Long timeout)
Sets the request timeout duration.

## Method: requestQueueSize(Integer requestQueueSize)
Sets the size of the request queue.

## Method: logLevel(feign.Logger.Level logLevel)
Sets the Feign logger level.

## Method: proxyConfig(ProxyConfig proxyConfig)
Sets the proxy configuration.

## Method: build()
Constructs and returns a new TwitchExtensionsCompatibilityLayer instance.
```

--------------------------------

### ChannelChatCondition.builder()

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/eventsub/condition/ChannelChatCondition.html

Creates a new builder instance for constructing a ChannelChatCondition object.

```APIDOC
## static ChannelChatCondition.ChannelChatConditionBuilder<?,?> builder()

### Description
Returns a builder instance to configure and create a new ChannelChatCondition object.

### Returns
- **ChannelChatConditionBuilder** - A builder for ChannelChatCondition.
```

--------------------------------

### getGlobalEmotes

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html

Gets all global emotes available to every user in Twitch chat.

```APIDOC
## getGlobalEmotes

### Description
Gets all global emotes. Global emotes are Twitch-specific emoticons that every user can use in Twitch chat.

### Method
SDK Method

### Signature
com.netflix.hystrix.HystrixCommand<EmoteList> getGlobalEmotes(String authToken)

### Parameters
- **authToken** (String) - Required - Any User OAuth Token or App Access Token.

### Returns
EmoteList
```

--------------------------------

### create

Source: https://twitch4j.github.io/javadoc/com/github/twitch4j/eventsub/socket/conduit/TwitchConduitSocketPool.html

Creates a managed websocket pool to serve as shards for an EventSub Conduit.

```APIDOC
## static TwitchConduitSocketPool create(Consumer<ConduitSpec> spec)

### Description
Creates a managed websocket pool to serve as shards for an EventSub Conduit. This pool can be used to create a completely new conduit or augment an existing one.

### Parameters
- **spec** (Consumer<ConduitSpec>) - Required - The specification by which to create a websocket pool for an EventSub Conduit.

### Returns
- **TwitchConduitSocketPool** - A new instance of the socket pool.

### Throws
- **CreateConduitException**, **ConduitNotFoundException**, **ConduitResizeException**, **ShardTimeoutException**, **ShardRegistrationException**
```
Tokens:
Raw