class Hamilton::Types::ForceReply

Overview

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/force_reply.cr

Constructors

.new(pull : JSON::PullParser)
.new(params)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)
.new(**params)

Instance Method Summary

#force_reply : Bool
Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
#force_reply=(force_reply : Bool)
Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
#input_field_placeholder : String | Nil
The placeholder to be shown in the input field when the reply is active; 1-64 characters.
#input_field_placeholder=(input_field_placeholder : String | Nil)
The placeholder to be shown in the input field when the reply is active; 1-64 characters.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#selective : Bool | Nil
Use this parameter if you want to force reply from specific users only.
#selective=(selective : Bool | Nil)
Use this parameter if you want to force reply from specific users only.

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def force_reply : Bool #

Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'

def force_reply=(force_reply : Bool) #

Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'

def input_field_placeholder : String | Nil #

The placeholder to be shown in the input field when the reply is active; 1-64 characters.

def input_field_placeholder=(input_field_placeholder : String | Nil) #

The placeholder to be shown in the input field when the reply is active; 1-64 characters.

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def selective : Bool | Nil #

Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.

def selective=(selective : Bool | Nil) #

hamilton