Teac.Api.Bits.Cheermotes (teac v0.3.0)

View Source

Summary

Functions

Get Cheermotes

Functions

get(opts)

Get Cheermotes

Gets a list of Cheermotes that users can use to cheer Bits in any Bits-enabled channel’s chat room. Cheermotes are animated emotes that viewers can assign Bits to.

Authorization

Requires an app access token or user access token.

Parameters

  • token : String - required
  • client_id : String - optional
  • broadcaster_id : integer - optional

Specify the broadcaster’s ID if you want to include the broadcaster’s Cheermotes in the response (not all broadcasters upload Cheermotes).

If not specified, the response contains only global Cheermotes.

Examples

iex> Teac.Api.Bits.Cheermotes.get(token :token)

{:ok,[%{
  "prefix" =>  "Cheer",
  "tiers" =>  [
  %{
    "min_bits" =>  1,
    "id" =>  "1",
    "color" =>  "#979797",
    "images" =>  %{
      "dark" =>  %{
        "animated" =>  %{
          "1" =>  "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/1.gif",
          ...
        },
        "static" =>  %{
          "1" =>  "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/1.png",
          ...
        }
      },
      "light" =>  %{
        "animated" =>  %{
          "1" =>  "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/1.gif",
          ...
        },
        "static" =>  {
          "1" =>  "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/1.png",
          ...
        }
      }
    },
    "can_cheer" =>  true,
    "show_in_bits_card" =>  true
  }
  },
  "type" =>  "global_first_party",
  "order" =>  1,
  "last_updated" =>  "2018-05-22T00:06:04Z",
  "is_charitable" =>  false
}],

}