Packages

final class ChatApi extends AnyVal

Telegram API for the chat object. Offers a convenient access to the related Telegram methods.

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChatApi
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChatApi(chat: Chat)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. def administrators[F[_]](implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[List[ChatMember]]

    returns

    list of administrators of this chat.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def deletePhoto[F[_]](implicit arg0: TelegramClient[F]): F[Boolean]

    Deletes the photo of the this chat.

  7. def deleteStickerSet[F[_]](implicit arg0: TelegramClient[F]): F[Boolean]

    Deletes a group of stickers set for this chat.

  8. def details[F[_]](implicit arg0: TelegramClient[F]): F[DetailedChat]

    returns

    Detailed information about this chat

  9. def exportInviteLink[F[_]](implicit arg0: TelegramClient[F]): F[String]

    Generates new invite link ofr this chat.

    Generates new invite link ofr this chat.

    Any previously generated link is revoked.

  10. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  11. def getMember[F[_]](userId: Int)(implicit arg0: TelegramClient[F]): F[ChatMember]

    returns

    Detailed information about the member of this chat.

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def kickUser[F[_]](userId: Int, untilDate: Option[Int] = None)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Kicks a user from this chat.

  14. def leave[F[_]](implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Abandons this chat.

  15. def membersCount[F[_]](implicit arg0: TelegramClient[F]): F[Int]

    returns

    number of members of this chat.

  16. def pinMessage[F[_]](messageId: Int, silent: Boolean = true)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Pins message in this chat, unless it's private chat.

  17. def promoteMember[F[_]](userId: Int, canChangeInfo: Option[Boolean] = None, canPostMessages: Option[Boolean] = None, canEditMessages: Option[Boolean] = None, canDeleteMessages: Option[Boolean] = None, canInviteUsers: Option[Boolean] = None, canRestrictMembers: Option[Boolean] = None, canPinMessages: Option[Boolean] = None, canPromoteMembers: Option[Boolean] = None)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Promotes or demotes a user in this chat.

  18. def restrictMember[F[_]](userId: Int, permissions: ChatPermissions, until: Option[Int] = None)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Restricts a user in a supergroup.

    Restricts a user in a supergroup.

    The bot must be an administrator in the supergroup and must have the appropriate admin rights.

  19. def send[F[_], M](content: MessageContent[M], replyToMessageId: Option[Int] = None, keyboard: Keyboard = Keyboard.Unchanged, disableNotification: Boolean = false)(implicit arg0: TelegramClient[F]): F[M]

    Sends a message to this chat.

  20. def sendAlbum[F[_]](media: List[InputMedia], disableNotification: Boolean = false)(implicit arg0: TelegramClient[F]): F[List[TelegramMessage]]

    Sends a list of media files as an album.

    Sends a list of media files as an album.

    media

    Must include 2-10 items

  21. def setAction[F[_]](action: ChatAction)(implicit arg0: TelegramClient[F]): F[Boolean]

    Sets the status of the bot for this chat.

    Sets the status of the bot for this chat.

    The action is set for 5 seconds or until the first message is send by the bot.

  22. def setDefaultPermissions[F[_]](permissions: ChatPermissions)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Sets default permissions for all chat members.

    Sets default permissions for all chat members.

    The bot must be an administrator in the group or a supergroup and must have the can_restrict_members admin rights.

  23. def setDescription[F[_]](description: String)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Changes the description of this chat if it's a group, a supergroup or a channel.

  24. def setTitle[F[_]](title: String)(implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Changes the title of this chat, unless it's private chat.

  25. def toString(): String
    Definition Classes
    Any
  26. def unbanMember[F[_]](userId: Int)(implicit arg0: TelegramClient[F]): F[Boolean]

    Unbans previously kicked user.

  27. def unpinMessage[F[_]](implicit arg0: TelegramClient[F], arg1: Applicative[F]): F[Boolean]

    Unpins pinned chat message.

Inherited from AnyVal

Inherited from Any

Ungrouped