ReplyKeyboardRemove Class

Upon receiving a message with this object,Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button.

Properties

  • selective: boolean

Methods

  • setSelective(selective: boolean)
  • toJSON()
{
  "id": 1816,
  "name": "ReplyKeyboardRemove",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Upon receiving a message with this object,Telegram clients will remove\nthe current custom keyboard and display the default letter-keyboard.\nBy default, custom keyboards are displayed until a new keyboard is sent by a bot.\nAn exception is made for one-time keyboards that are hidden immediately after the user presses a button."
      }
    ]
  },
  "children": [
    {
      "id": 1817,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
          "line": 19,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1818,
          "name": "new ReplyKeyboardRemove",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
              "line": 19,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1819,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 2376,
                "name": "ReplyKeyboardRemoveData",
                "package": "tgkit"
              },
              "defaultValue": "{}"
            }
          ],
          "type": {
            "type": "reference",
            "target": 1816,
            "name": "ReplyKeyboardRemove",
            "package": "tgkit",
            "qualifiedName": "default"
          }
        }
      ]
    },
    {
      "id": 1820,
      "name": "selective",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Use this parameter if you want to show the keyboard to specific users only.\nTargets:\n1) users that are"
          }
        ],
        "blockTags": [
          {
            "tag": "@mentioned",
            "content": [
              {
                "kind": "text",
                "text": "in the text of the Message object;\n2) if the bot's message is a reply (has replyToMessageId),\n3) sender of the original message."
              }
            ]
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
          "line": 17,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1821,
      "name": "setSelective",
      "variant": "declaration",
      "kind": 2048,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
          "line": 23,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1822,
          "name": "setSelective",
          "variant": "signature",
          "kind": 4096,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
              "line": 23,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1823,
              "name": "selective",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "boolean"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1816,
            "name": "ReplyKeyboardRemove",
            "package": "tgkit",
            "qualifiedName": "default"
          }
        }
      ]
    },
    {
      "id": 1824,
      "name": "toJSON",
      "variant": "declaration",
      "kind": 2048,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
          "line": 28,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1825,
          "name": "toJSON",
          "variant": "signature",
          "kind": 4096,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
              "line": 28,
              "character": 1
            }
          ],
          "type": {
            "type": "intrinsic",
            "name": "object"
          }
        }
      ]
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1817
      ]
    },
    {
      "title": "Properties",
      "children": [
        1820
      ]
    },
    {
      "title": "Methods",
      "children": [
        1821,
        1824
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/ReplyKeyboardRemove.ts",
      "line": 9,
      "character": 21
    }
  ]
}