telega - v0.15.0

telega/reactions

reactions provides convenient helpers for working with Telegram reactions.

Sending reactions

import telega/reactions

// React to current message with emoji
reactions.react(ctx, reactions.thumbs_up)

// React with custom emoji string
reactions.react_emoji(ctx, "👍")

// React with big animation
reactions.react_big(ctx, reactions.heart)

Handling reaction updates

import telega/router
import telega/reactions

router.new()
|> router.on_reaction(fn(ctx, update) {
  let changes = reactions.get_changes(update)
  // Process added/removed reactions
  Ok(ctx)
})

Types

ReactionChanges

</>

Information about reaction changes

pub type ReactionChanges {
  ReactionChanges(
    added: List(types.ReactionType),
    removed: List(types.ReactionType),
    kept: List(types.ReactionType),
  )
}

Constructors

ReactionCountInfo

</>

Reaction count information

pub type ReactionCountInfo {
  ReactionCountInfo(reaction: types.ReactionType, count: Int)
}

Constructors

Values

angry

</> 
pub const angry: types.ReactionType

clap

</> 
pub const clap: types.ReactionType

clear_reaction

</> 
pub fn clear_reaction(
  ctx ctx: bot.Context(session, error),
) -> Result(Bool, error.TelegaError)

Clear all bot’s reactions from the current message

Example

reactions.clear_reaction(ctx)

custom_emoji

</> 
pub fn custom_emoji(
  custom_emoji_id: String,
) -> types.ReactionType

Create a custom emoji reaction

emoji

</> 
pub fn emoji(emoji_str: String) -> types.ReactionType

Create an emoji reaction

eyes

</> 
pub const eyes: types.ReactionType

fire

</> 
pub const fire: types.ReactionType

get_changes

</> 
pub fn get_changes(
  update: types.MessageReactionUpdated,
) -> ReactionChanges

Get detailed information about reaction changes

Example

let changes = reactions.get_changes(update)
list.each(changes.added, fn(r) {
  case reactions.get_emoji(r) {
    Some(e) -> io.println("Added: " <> e)
    None -> Nil
  }
})

get_counts

</> 
pub fn get_counts(
  update: types.MessageReactionCountUpdated,
) -> List(ReactionCountInfo)

Get all reaction counts from a MessageReactionCountUpdated

get_custom_emoji_id

</> 
pub fn get_custom_emoji_id(
  reaction: types.ReactionType,
) -> option.Option(String)

Get custom emoji ID from a ReactionType (if it’s a custom emoji reaction)

get_emoji

</> 
pub fn get_emoji(
  reaction: types.ReactionType,
) -> option.Option(String)

Get emoji string from a ReactionType (if it’s an emoji reaction)

Example

case reactions.get_emoji(reaction) {
  Some(emoji) -> io.println("Emoji: " <> emoji)
  None -> io.println("Not an emoji reaction")
}

get_emoji_count

</> 
pub fn get_emoji_count(
  update: types.MessageReactionCountUpdated,
  emoji_str: String,
) -> Int

Get count for a specific emoji

get_top_reactions

</> 
pub fn get_top_reactions(
  update: types.MessageReactionCountUpdated,
  limit: Int,
) -> List(ReactionCountInfo)

Get top reactions sorted by count

get_total_count

</> 
pub fn get_total_count(
  update: types.MessageReactionCountUpdated,
) -> Int

Get total count across all reactions

has_added

</> 
pub fn has_added(update: types.MessageReactionUpdated) -> Bool

Check if there are any added reactions

has_removed

</> 
pub fn has_removed(update: types.MessageReactionUpdated) -> Bool

Check if there are any removed reactions

heart

</> 
pub const heart: types.ReactionType

hundred

</> 
pub const hundred: types.ReactionType

is_custom_emoji

</> 
pub fn is_custom_emoji(reaction: types.ReactionType) -> Bool

Check if a reaction is a custom emoji reaction

is_emoji

</> 
pub fn is_emoji(reaction: types.ReactionType) -> Bool

Check if a reaction is an emoji reaction

is_paid

</> 
pub fn is_paid(reaction: types.ReactionType) -> Bool

Check if a reaction is a paid reaction (stars)

laugh

</> 
pub const laugh: types.ReactionType

matches_emoji

</> 
pub fn matches_emoji(
  reaction: types.ReactionType,
  emoji_str: String,
) -> Bool

Check if a reaction matches a specific emoji

ok

</> 
pub const ok: types.ReactionType
</> 
pub fn paid() -> types.ReactionType

Create a paid reaction (stars)

party

</> 
pub const party: types.ReactionType

poop

</> 
pub const poop: types.ReactionType

react

</> 
pub fn react(
  ctx ctx: bot.Context(session, error),
  reaction reaction: types.ReactionType,
) -> Result(Bool, error.TelegaError)

React to the current message with a reaction

Example

reactions.react(ctx, reactions.thumbs_up)

react_big

</> 
pub fn react_big(
  ctx ctx: bot.Context(session, error),
  reaction reaction: types.ReactionType,
) -> Result(Bool, error.TelegaError)

React to the current message with a big animation

Example

reactions.react_big(ctx, reactions.party)

react_emoji

</> 
pub fn react_emoji(
  ctx ctx: bot.Context(session, error),
  emoji_str emoji_str: String,
) -> Result(Bool, error.TelegaError)

React to the current message with an emoji string

Example

reactions.react_emoji(ctx, "👍")

react_many

</> 
pub fn react_many(
  ctx ctx: bot.Context(session, error),
  reactions reactions: List(types.ReactionType),
) -> Result(Bool, error.TelegaError)

React to the current message with multiple reactions

Example

reactions.react_many(ctx, [reactions.thumbs_up, reactions.heart])

react_to_chat_message

</> 
pub fn react_to_chat_message(
  ctx ctx: bot.Context(session, error),
  chat_id chat_id: Int,
  message_id message_id: Int,
  reaction reaction: types.ReactionType,
) -> Result(Bool, error.TelegaError)

React to a specific message in a specific chat

Example

reactions.react_to_chat_message(ctx, chat_id: -100123, message_id: 456, reaction: reactions.fire)

react_to_message

</> 
pub fn react_to_message(
  ctx ctx: bot.Context(session, error),
  message_id message_id: Int,
  reaction reaction: types.ReactionType,
) -> Result(Bool, error.TelegaError)

React to a specific message by ID

Example

reactions.react_to_message(ctx, message_id: 123, reaction: reactions.heart)

reaction_equals

</> 
pub fn reaction_equals(
  a: types.ReactionType,
  b: types.ReactionType,
) -> Bool

Check if two reactions are equal

sad

</> 
pub const sad: types.ReactionType

thinking

</> 
pub const thinking: types.ReactionType

thumbs_down

</> 
pub const thumbs_down: types.ReactionType

thumbs_up

</> 
pub const thumbs_up: types.ReactionType

was_added

</> 
pub fn was_added(
  update: types.MessageReactionUpdated,
  emoji_str: String,
) -> Bool

Check if a specific emoji was added

Example

if reactions.was_added(update, "👍") {
  // Handle like
}

was_removed

</> 
pub fn was_removed(
  update: types.MessageReactionUpdated,
  emoji_str: String,
) -> Bool

Check if a specific emoji was removed

Example

if reactions.was_removed(update, "👍") {
  // Handle unlike
}

wow

</> 
pub const wow: types.ReactionType
✨ Search Document