Class FrankerFacezApiV1

Method Details

• instance

  public static EmoteProvider instance()

• getGlobalEmotes

  public List<EmoteEntry> getGlobalEmotes() throws EmoteApiRequestFailedException

  Description copied from interface: EmoteProvider

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

  Specified by:

  getGlobalEmotes in interface EmoteProvider

  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

• getSharedEmotes

  public List<EmoteEntry> getSharedEmotes() throws EmoteApiRequestFailedException

  Description copied from interface: EmoteProvider

  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

  Specified by:

  getSharedEmotes in interface EmoteProvider

  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

• getProviderName

  public String getProviderName()

  Description copied from interface: EmoteProvider

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

  Specified by:

  getProviderName in interface EmoteProvider

  Returns:

  the codename of the provider