Interface EmoteProvider

Method Details

• getProviderName

  String getProviderName()

  Returns the name of the provider (for code usage, not for human reading)

  Returns:

  the codename of the provider

• getLocalEmotes

  default List<EmoteEntry> getLocalEmotes() throws EmoteApiRequestFailedException

  Retrieves all emotes which are local to the channel by the emote provider

  Returns:

  list of all emotes local to the channel of the provider or null if not supported

  Throws:

  EmoteApiRequestFailedException - when the api request or parsing of the response fails

• getSharedEmotes

  default List<EmoteEntry> getSharedEmotes() throws EmoteApiRequestFailedException

  Retrieves all emotes which are selected from a shared pool of the emote provider and thus not exclusive to the channel but allowed to use under the terms of the provider

  Returns:

  list of all the selected shared emotes of the provider or null if not supported

  Throws:

  EmoteApiRequestFailedException - when the api request or parsing of the response fails

• getGlobalEmotes

  default List<EmoteEntry> getGlobalEmotes() throws EmoteApiRequestFailedException

  Retrieves all emotes which are globally available to all users of the emote provider

  Returns:

  list of all globally available emotes of the provider or null if not supported

  Throws:

  EmoteApiRequestFailedException - when the api request or parsing of the response fails