Class

com.bot4s.telegram.methods

KickChatMember

Related Doc: package methods

Permalink

case class KickChatMember(chatId: ChatId, userId: Int, untilDate: Option[Int] = None) extends JsonRequest[Boolean] with Product with Serializable

Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Note: In regular groups (non-supergroups), this method will only work if the "All Members Are Admins" setting is off in the target group. Otherwise members may only be removed by the group's creator or by the member that added them.

chatId

Integer or String Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername)

userId

Integer Unique identifier of the target user

untilDate

Integer Optional Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever

Linear Supertypes
Serializable, Serializable, Product, Equals, JsonRequest[Boolean], Request[Boolean], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KickChatMember
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. JsonRequest
  7. Request
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KickChatMember(chatId: ChatId, userId: Int, untilDate: Option[Int] = None)

    Permalink

    chatId

    Integer or String Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername)

    userId

    Integer Unique identifier of the target user

    untilDate

    Integer Optional Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val chatId: ChatId

    Permalink

    Integer or String Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername)

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  11. def methodName: String

    Permalink

    Extract request URL from class name.

    Extract request URL from class name.

    Definition Classes
    Request
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. val untilDate: Option[Int]

    Permalink

    Integer Optional Date when the user will be unbanned, unix time.

    Integer Optional Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever

  17. val userId: Int

    Permalink

    Integer Unique identifier of the target user

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from JsonRequest[Boolean]

Inherited from Request[Boolean]

Inherited from AnyRef

Inherited from Any

Ungrouped